Skip to content

Commit

Permalink
Merge pull request #735 from PaologGithub/master
Browse files Browse the repository at this point in the history
Updated README.md
  • Loading branch information
pokepetter authored Dec 9, 2024
2 parents cef3cb7 + c4f0d31 commit afafe01
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ursina ʕ •ᴥ•ʔゝ□

[Website](https://www.ursinaengine.org/index.html) | [Discord](https://discord.gg/ydXfhyb) | [Twitter](https://twitter.com/ursinaengine) | [Patreon](https://www.patreon.com/ursinaengine) | [Sponsor](https://github.com/sponsors/pokepetter)
[Website](https://pokepetter.github.io/ursina/index.html) | [Discord](https://discord.gg/ydXfhyb) | [Twitter](https://twitter.com/ursinaengine) | [Patreon](https://www.patreon.com/ursinaengine) | [Sponsor](https://github.com/sponsors/pokepetter)

An easy to use game engine/framework for python.

Expand All @@ -9,7 +9,8 @@ An easy to use game engine/framework for python.
[![Trailer](/docs/ursina_trailer_preview.webp)](https://youtu.be/j71j88oCTNo)

## Getting Started
1) Install Python 3.6 or newer. https://www.python.org/downloads/
1) Install [Python 3.10 or newer.](https://www.python.org/downloads/release/python-3100)

2) Open cmd/terminal and type:

```
Expand All @@ -25,7 +26,7 @@ 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/
repo and install as develop like this. Make sure you have [git](https://git-scm.com) installed.

```
git clone https://github.com/pokepetter/ursina.git
Expand All @@ -50,7 +51,7 @@ Where 3.xx is the version you want to target.


## Dependencies
* python 3.6+
* python 3.10+
* panda3d
* pillow, for texture manipulation
* psd-tools, for converting .psd files
Expand All @@ -77,10 +78,11 @@ app.run() # opens a window and starts the game.
```


* [Minecraft Clone](/samples/minecraft_clone.py)
* [Minecraft Clone](https://pokepetter.github.io/ursina/minecraft_clone.html)

* [Platformer Game](/samples/platformer.py)
* [Platformer Game](https://pokepetter.github.io/ursina/platformer.html)

There are other examples in [the samples folder](https://github.com/pokepetter/ursina/tree/master/samples), or in [samples website](https://pokepetter.github.io/ursina/samples.html)

## 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.
Expand Down Expand Up @@ -114,6 +116,17 @@ app.run() # opens a window and starts the game.

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.

## Documentation
If you need help, you can refer to the following documentation sites:
* [Ursina Documentation](https://pokepetter.github.io/ursina/documentation.html)
- Can give you a lot of help, because it explains how Ursina works
* [Ursina API Reference](https://pokepetter.github.io/ursina/api_reference.html)
- List the different functionalities of ursina, with example code
* [Samples](https://pokepetter.github.io/ursina/samples.html)
- Little games with simple code, as examples

You found a bug? You can help ursina by posting it in [the issues](https://github.com/pokepetter/ursina/issues), or by making a [pull request](https://github.com/pokepetter/ursina/pulls)


## Project Structure
```
Expand Down

0 comments on commit afafe01

Please sign in to comment.