kyush/principia
1
0
Fork 0
forked from mirrors/principia
Code Pull requests Activity Actions

Update README with gif and formatting fixes

Browse source
This commit is contained in:
Emil Romanus 2022-08-06 19:46:29 +02:00 • committed by GitHub
commit 7f6887b82d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1,13 +1,16 @@
Principia Open Source Project
=========
![Principia](https://raw.githubusercontent.com/Bithack/principia/master/data-src/github-image0.gif)
Principia is a sandbox physics game originally released in November 2013. It is the successor to the Android hit game "Apparatus".
The project can be built on Windows, Linux, Android or iOS. The iOS version lags behind and lacks a lot of UI. The Android version is outdated and probably needs some work to compile.
Principia can be built on Windows, Linux, Android or iOS. The iOS version lags behind and lacks a lot of UI. The Android version is outdated and probably needs some work to compile.
Compilation on Windows and Linux should be easy, see further below.
NOTE!
Mote documentation and resources will come.
More documentation and resources will come in short!
Getting involved
--------
@ -17,41 +20,56 @@ https://discord.gg/qV6APzKfk9
Follow Bithack on Twitter:
https://www.twitter.com/Bithack
Compiling and running
Building and running
--------
## Building on Windows
- Install MSYS2 64bit
The game engine behind Principia (TMS) is written in the C99 standard of C. Unfortunately, the Visual Studio C compiler does not support the C99 standard. Principia must therefore be compiled using the MSYS2 MINGW64 toolchain, as described below.
Please find the latest version of the 64-bit MSYS2 here: https://www.msys2.org/
After installation, a terminal opens. Run the following command to update the environment:
$ pacman -Syu
Terminal will ask to close it self when done. GO to start menu and run MSYS Mingw32 64-bit
The terminal will then ask you to close it when done. Proceed with doign so, and then go to the start menu and run MSYS Mingw32 64-bit. It is important that you run the "MINGW64 64-Bit" version and not the "MSYS2 MSYS" or "MINGW64 32-Bit". Run the commands below to install the necessary dependencies.
$ pacman -S --neded base-devel mingw-w64-x86_64-toolchain autotools
$ pacman -S mingw-w64-x86_64-gtk2
$ pacman -S mingw-w64-x86_64-curl
Navigate to the 'build-windows' folder inside where you cloned Principia, for example:
Then navigate to the 'build-windows' folder inside of where you cloned Principia, for example:
$ cd /c/Users/<username>/Principia/build-windows
And start the building process:
$ ./autogen.sh
$ ./configure
$ ./go
Clean with:
$ make clean
Principia will launch if everything was successful. Note that the compilation might take up to 10 minutes depending on your system.
## Building on Linux (Debian)
Install dependencies:
$ sudo apt-get install automake libgtk2.0-dev libgl-dev libxss-dev libxxf86vm-dev libasound2-dev libudev-dev valgrind
Navigate to the build-linux directory and start the building process:
$ cd build-linux;
$ ./go
$ ./autogen.sh
$ ./configure
$ ./go
If everything goes well, Principia will start but then freeze at the loading screen due some uninitialize directories. Terminate Principia by replying 'y' in the gdb prompt in the terminal, then in the same terminal, go up a directory and launch it from the parent directory instead:
@ -61,7 +79,6 @@ $ build-linux/apparatus2
(this bug will be fixed in short)
License
---------
See LICENSE.md