mirror of
https://github.com/quantum5/punyverse.git
synced 2025-04-24 13:11:57 -04:00
Release punyverse 1.0.
This commit is contained in:
parent
2a9eacf37e
commit
4d58450429
28
README.md
28
README.md
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Python simulator of a puny universe. (How many words can I stick into one?)
|
Python simulator of a puny universe. (How many words can I stick into one?)
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -11,10 +11,30 @@ To install, run `pip install punyverse`.
|
||||||
If you are on Windows, run `punyverse_make_launcher`. This should create special launchers that runs `punyverse` on
|
If you are on Windows, run `punyverse_make_launcher`. This should create special launchers that runs `punyverse` on
|
||||||
your dedicated graphics card, should it exist.
|
your dedicated graphics card, should it exist.
|
||||||
|
|
||||||
|
Your graphics card might not support some of the larger textures used by `punyverse`, and so startup might fail.
|
||||||
|
To solve this problem, run `punyverse_small_images`. It will do nothing if your graphics card supports all the
|
||||||
|
textures, so when in doubt, run `punyverse_small_images` after installation.
|
||||||
|
|
||||||
Then, run `punyverse` to launch the simulator, or `punyversew` to launch without the console.
|
Then, run `punyverse` to launch the simulator, or `punyversew` to launch without the console.
|
||||||
|
|
||||||
### A Note on Textures
|
### Summary
|
||||||
|
|
||||||
If your graphics card doesn't support the massive texture sizes this module comes with, you can shrink them.
|
```bash
|
||||||
|
pip install punyverse
|
||||||
|
punyverse_make_launcher
|
||||||
|
punyverse_small_images
|
||||||
|
# Installation finished. Run:
|
||||||
|
punyverse
|
||||||
|
```
|
||||||
|
|
||||||
To do this, run `punyverse_small_images`.
|
## Troubleshooting
|
||||||
|
|
||||||
|
If `punyverse` does not work, try upgrading your graphics card drivers.
|
||||||
|
|
||||||
|
If your graphics card does not appear to support OpenGL 3.3, then you cannot run the latest version of `punyverse`.
|
||||||
|
You can try `pip install -U punyverse==0.5` to install the last version of `punyverse` to support legacy devices.
|
||||||
|
You can download the wheels manually from [the PyPI page](https://pypi.org/project/punyverse/0.5/).
|
||||||
|
|
||||||
|
If the problem is unrelated to your graphics card, and it persists, try running punyverse under debug mode. To do this,
|
||||||
|
run `punyverse` as `punyverse --debug`. Then paste the entirety of the output into a new GitHub issue
|
||||||
|
[here](https://github.com/quantum5/punyverse/issues/new).
|
||||||
|
|
Loading…
Reference in a new issue