Getting Started#
Installation#
Installing rubato is simple. Make sure you have Python 3.10 or later installed, then run the following in a terminal:
$ pip install rubato
Note
Setting Up#
Once you've installed rubato, setting up a new project is easy.
To create a new blank project, simply create a new python file (such as main.py) and type the following:
import rubato as rb
rb.init()
rb.init() initializes rubato.
rb.init() takes in multiple optional arguements to specify things such as window name and size, resolution, and more.
Note
Throughout our documentation, we assume that rubato is imported as rb.
If you used from rubato import *, just delete the rb. prefix where needed.
Now that rubato is ready, add the following line of code to the end of the file:
rb.begin()
rb.begin() is the function that starts the rubato engine.
Without it, rubato won't know to begin the engine cycle, and your game won't run.
It is recommended to call rb.begin() at the bottom of your project file as in this example.
Now run your code in a terminal using python YOUR_FILENAME.py. If you see a white square window, congrats!
You're officially up and running with rubato.
Warning
When you are working with rubato, make sure to only call rubato functions after calling init() and before begin().
Note that any code placed after begin() wont run, because the function blocks the main thread.