6 Commits

5 changed files with 46 additions and 36 deletions

View File

@@ -1,10 +0,0 @@
v0.1: First Release
- Basic simulation.
- Information printing.
v0.2: Menu Bar
- Added a menu bar.
- Can reset the simulation.
v0.3: Port to C
- Codebase ported to C for better performance.

21
CHANGELOG.md Normal file
View File

@@ -0,0 +1,21 @@
# Change Log
## v0.4: More functionality
- Fix acceleration.
- Add fullscreen support.
- Pause functionality.
## v0.3: Port to C
- Codebase ported to C for better performance.
## v0.2: Menu Bar
- Added a menu bar.
- Can reset the simulation.
## v1.0: First Release
- Basic simulation.
- Information printing.

View File

@@ -18,7 +18,7 @@ cmake_minimum_required(VERSION 3.10)
project(SpaceShipSim C) project(SpaceShipSim C)
set(TARGET_NAME "spaceshipsim") set(TARGET_NAME "spaceshipsim")
set(TARGET_VERSION "0.3") set(TARGET_VERSION "0.4")
if(NOT CMAKE_BUILD_TYPE) if(NOT CMAKE_BUILD_TYPE)
set(CMAKE_BUILD_TYPE "release") set(CMAKE_BUILD_TYPE "release")
@@ -48,8 +48,7 @@ set(SRCS
add_definitions(-DVERSION="${TARGET_VERSION}") add_definitions(-DVERSION="${TARGET_VERSION}")
if(${CMAKE_BUILD_TYPE} STREQUAL "debug" OR if(${CMAKE_BUILD_TYPE} STREQUAL "debug" OR ${CMAKE_BUILD_TYPE} STREQUAL "relwithdebinfo")
${CMAKE_BUILD_TYPE} STREQUAL "relwithdebinfo")
add_definitions(-DDEBUG) add_definitions(-DDEBUG)
else() else()
add_definitions(-DNDEBUG) add_definitions(-DNDEBUG)

View File

@@ -1,39 +1,40 @@
==================== # SpaceShipSim
*** SpaceShipSim ***
====================
This is a small simulation program of a space ship (with infinite fuel) in a This is a small simulation program of a space ship (with infinite fuel) in a
frictionless environment (space). The idea is to use it for educational frictionless environment (space). The idea is to use it for educational
purposes. purposes.
# Compiling ## Compiling
-----------
In order to build this program you will require the following dependencies: In order to build this program you will require the following dependencies:
- GNU GCC (https://gcc.gnu.org/) - A C compiler that supports C99 or higher
- CMake (https://cmake.org/) - CMake 3.10 or higher
- Allegro 5 (http://liballeg.org/) - Allegro 5
You can then compile the program via the following commands: You can then compile the program via the following commands:
cd build/ ```bash
cmake .. cd build/
make cmake ..
make
```
This will create a release build with compiler optimizations. If you would like This will create a release build with compiler optimizations. If you would like
a debug build then pass the `-DCMAKE_BUILD_TYPE=debug' flag to the `cmake' a debug build then pass the `-DCMAKE_BUILD_TYPE=debug` flag to the `cmake`
command. If you would like to install then run `cmake' with the additional flag command. If you would like to install then run `cmake` with the additional flag
`-DCMAKE_INSTALL_PREFIX=<install_dir>'. If you are installing as a user then `-DCMAKE_INSTALL_PREFIX=<install_dir>`. If you are installing as a user then
you may want to set the installation prefix to `/usr/local/', and if you're you may want to set the installation prefix to `/usr/local/`, and if you're
packaging then please consult your distribution's policies. With this you packaging then please consult your distribution's policies. With this you
should be able to run the `make install' target and install the binary. should be able to run the `make install' target and install the binary.
# Contributing ## Contributing
--------------
If you would like to contribute to the project, send a patch file to my e-mail If you would like to contribute to the project, send a patch file to my e-mail
address: <nortega@themusicinnoise.net>. address: [nicolas@ortegas.org](mailto:nicolas@ortegas.org).
## License
# License
---------
As educational software, unless otherwise noted, all files are licensed under As educational software, unless otherwise noted, all files are licensed under
the terms & conditions of the GNU General Public License version 3 or greater the terms & conditions of the GNU General Public License version 3 or greater
(see `LICENSE' file for more information). (see the [license file](LICENSE) for more information).

1
TODO
View File

@@ -1,3 +1,2 @@
TODO: TODO:
- Add a fullscreen mode.
- Add presets with stellar masses (for gravity simulation). - Add presets with stellar masses (for gravity simulation).