ursina ʕ •ᴥ•ʔゝ□ #

An easy to use game engine/framework for python.

Getting Started #

Install Python 3.6 or newer. https://www.python.org/downloads/
Open cmd/terminal and type:
```
 pip install ursina
```

If you want to install the newest version from git, you can install like this:

    pip install git+https://github.com/pokepetter/ursina.git

If you want to easily edit the source, it’s recommended to clone the git repo and install as develop like this. Make sure you have git installed. https://git-scm.com/

    git clone https://github.com/pokepetter/ursina.git
    python setup.py develop

Also install any of the optional dependencies you want from the list below, or install them all with:

    pip install ursina[extras]

On some systems you might have to use pip3 instead of pip in order to use Python 3 and not the old Python 2.

Dependencies #

python 3.6+
panda3d
screeninfo, for detecting screen resolution
hurry.filesize, for converting bytes to megabytes
pillow, for texture manipulation
psd-tools, for converting .psd files
blender, for converting .blend files
pyperclip, for copy/pasting

Examples #

from ursina import *            # this will import everything we need from ursina with just one line.

app = Ursina()
ground = Entity(
    model = 'cube',
    color = color.magenta,
    z = -.1,
    y = -3,
    origin = (0, .5),
    scale = (50, 1, 10),
    collider = 'box',
    )

app.run()                       # opens a window and starts the game.

How do I make a game? #

Ursina games are made by writing Python code. You can use any text editor you want, but personally I like to use Atom.

Create an empty .py file called ‘ursina_game.py’
Copy this text into your new file:

from ursina import *           # this will import everything we need from ursina with just one line.

app = Ursina()

player = Entity(
    model = 'cube' ,           # finds a 3d model by name
    color = color.orange,
    scale_y = 2
    )

def update():                  # update gets automatically called by the engine.
    player.x += held_keys['d'] * .1
    player.x -= held_keys['a'] * .1


app.run()                     # opens a window and starts the game.

Type this in the terminal to start the game:
```
python ursina_game.py
```
If you use Atom, I recommend installing the package atom-python-run to run your scripts with the press of a button.
You can now move the orange box around with ‘a’ and ’d’!
To close the window, you can by default, press shift+q or press the red x. to disable this, write ‘window.exit_button.enabled = False’ somewhere in your code.