Skip to content

Commit e9185d0

Browse files
committed
Update README.md
1 parent a0f3685 commit e9185d0

File tree

5 files changed

+13
-517
lines changed

5 files changed

+13
-517
lines changed

README.md

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,17 @@ Nova Physics is a lightweight and easy to use 2D physics engine.
88
</p>
99

1010

11-
This is re-packaged Nova Physics Python bindings, as currently official bindings fail to build with ``pip install git+https://github.com/kadir014/nova-physics-python.git`` command.
11+
This is re-packaged Nova Physics Python bindings, with custom patches.
1212

13-
Install with ``pip install git+https://github.com/gresm/nova-physics-python-fixed.git``
14-
15-
The command will try to use the [Nova Physics](https://github.com/kadir014/nova-physics) binaries and fall-backs if none found, if you want to force usage pre-build Nova binaries run:
16-
``NOVA_FORCE="binaries" pip install git+https://github.com/gresm/nova-physics-python-fixed.git``
17-
Binaries can be found [here](nova-binaries) but currently only for Linux x86/x86_64. To force building from source run ``NOVA_FORCE="source" pip install git+https://github.com/gresm/nova-physics-python-fixed.git``
13+
Install with:
14+
```shell
15+
pip install git+https://github.com/gresm/nova-physics-python-fixed.git
16+
```
1817

1918
The package will be installed under ``nova-physics`` namespace, but to import it in python use ``import nova``. Uninstalling is simple as ``pip uninstall nova-physics``.
2019

21-
22-
# Excerpts from the original [README.md](nova-physics-python/README.md):
23-
24-
> # Python binding for [Nova Physics Engine](https://github.com/kadir014/nova-physics)
25-
>
26-
> This binding aims to provide a Pythonic API while keeping everything as similar as to the original.
27-
>
28-
> ## Usage
29-
> ```py
30-
> import nova
31-
>
32-
> # Create the space
33-
> space = nova.Space()
34-
>
35-
> # Create a body with box shape
36-
> body = nova.Rect(
37-
> nova.DYNAMIC, # Type of the body
38-
> nova.Vector2(0, 0), # Initial position of the body
39-
> 0, # Initial rotation of the body
40-
> 5, 5 # Width & height of the rect shape
41-
> )
42-
>
43-
> # Add body to the space
44-
> space.add(body)
45-
>
46-
> # Main loop
47-
> while True:
48-
> # Advance the simulation with the timestep of 60 times a second.
49-
> space.step(1 / 60)
50-
> ```
51-
>
52-
> ## Requirements
53-
> - [Python](https://www.python.org/downloads/) (3.8+)
54-
> - [Nova Physics](https://github.com/kadir014/nova-physics) (Prebuilt in the PyPI release)
55-
> - [Setuptools](https://pypi.org/project/setuptools/) (Should be included by default)
56-
>
57-
> ## License
58-
> [MIT](LICENSE) © Kadir Aksoy
20+
As of currently, this will build [Nova Physics](https://github.com/kadir014/nova-physics) library from source - support for pre-building it is not yet available.
21+
By default, this uses a stable release of [Nova Physics](https://github.com/kadir014/nova-physics), if you want a nightly version, run:
22+
```shell
23+
BUILD_NIGHTLY=1 pip install git+https://github.com/gresm/nova-physics-python-fixed.git
24+
```

setup.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,18 @@
1212

1313

1414
if platform.system() == "Darwin":
15-
# Fuck OSX
15+
# ???
1616
import ssl
1717
ssl._create_default_https_context = ssl._create_unverified_context
1818

1919

2020
BUILD_WEB = False
21-
if "--web" in sys.argv:
21+
if "BUILD_WEB" in os.environ:
2222
BUILD_WEB = True
23-
sys.argv.remove("--web")
2423

2524
BUILD_NIGHTLY = False
26-
if "--nightly" in sys.argv:
25+
if "BUILD_NIGHTLY" in os.environ:
2726
BUILD_NIGHTLY = True
28-
sys.argv.remove("--nightly")
2927

3028

3129
BASE_PATH = Path(os.getcwd())

src/cffi_comp.py

Lines changed: 0 additions & 46 deletions
This file was deleted.

src/cffi_gen.py

Lines changed: 0 additions & 103 deletions
This file was deleted.

0 commit comments

Comments
 (0)