repo: add README

This commit is contained in:
Kevin J. 2024-11-04 14:27:41 +01:00
parent 61faff439b
commit 4194d8f492
2 changed files with 74 additions and 31 deletions

38
GAME Normal file
View File

@ -0,0 +1,38 @@
EO
RETRO 2D GAME
FRONT-BACK
CRAFTING SYSTEM
STORY
PRESTORY
Nei, a computer engineer, electrician, as well as a soldier. You are stranded
in a lost colony of EnO, a planet once deemed all-important for the members of
the ISN - Inter-Stellar Nations. For hundreds of stellar revolutions, the
planet served as an ingress to the Cycos system. Inside the Cycos system, one
found 6 planets, all extremely abundant in rich and valuable materials. The
star's radius spanned millions of kilometers and was seen as a perfect
candidate for building a megastructure around and extrapolating all energy.
Although abundant in materials, these planets housed the most extreme of
environments in the whole universe. At first, EnO was the only candidate that
seemed to have a normal terrain, relatively safe conditions for a planet with
an extremely thin atmosphere, and lack of planetary hazards like strong storms,
tsunamis, strong earthquakes, and similar. Many ISN nations started colonies on
this planet to study the rich planets from up close. But due to the ignorance
of the whole ISN, none of the nations sought to resolve the sharing of land
through peace, but only through extensive imperialism. Which led to everything
but victory. Through revolutions, the nations saw that there was no place
left for EnO. The planet itself turned out to be a hazard because of the
explosives and traps still active. The ones still alive on that planet have
been left there to rot with the already rotten. You are one of them. And you
have to escape this new-born hell.
MAIN STORY
ENDING
Nei crafts the ship and traverses the Cycos system, leaving the hell behind.

67
README
View File

@ -1,38 +1,43 @@
EO
EO
RETRO 2D GAME
FRONT-BACK
CRAFTING SYSTEM
2D game. You can find game info inside the GAME file
STORY
TECHNICALS
PRESTORY
The underlying API renderer is BGFX.
Source code is C++.
Nei, a computer engineer, electrician, as well as a soldier. You are stranded
in a lost colony of EnO, a planet once deemed all-important for the members of
the ISN - Inter-Stellar Nations. For hundreds of stellar revolutions, the
planet served as an ingress to the Cycos system. Inside the Cycos system, one
found 6 planets, all extremely abundant in rich and valuable materials. The
star's radius spanned millions of kilometers and was seen as a perfect
candidate for building a megastructure around and extrapolating all energy.
Although abundant in materials, these planets housed the most extreme of
environments in the whole universe. At first, EnO was the only candidate that
seemed to have a normal terrain, relatively safe conditions for a planet with
an extremely thin atmosphere, and lack of planetary hazards like strong storms,
tsunamis, strong earthquakes, and similar. Many ISN nations started colonies on
this planet to study the rich planets from up close. But due to the ignorance
of the whole ISN, none of the nations sought to resolve the sharing of land
through peace, but only through extensive imperialism. Which led to everything
but victory. Through revolutions, the nations saw that there was no place
left for EnO. The planet itself turned out to be a hazard because of the
explosives and traps still active. The ones still alive on that planet have
been left there to rot with the already rotten. You are one of them. And you
have to escape this new-born hell.
The game also uses other libraries related to BGFX
such as BX and BIMG
MAIN STORY
Windowing is handled by GLFW
Debugging is handled by ImGui
Model loading is handled by Assimp
Math functions are provided by GLM
shaders are compiled to 440 GLSL for Linux.
ENDING
Nei crafts the ship and traverses the Cycos system, leaving the hell behind.
BUILD AND RUN
git clone http://git.0xdeadbeer.xyz/0xdeadbeer/eo
cd eo
mkdir build
cd build
cmake ..
make
./eo # run the game
SUBMODULES
bgfx.cmake
glfw.cmake
imgui.cmake
assimp.cmake
glm.cmake