Skip to content

Commit 887d219

Browse files
committed
readme, updated base example, added submodule instructions
1 parent bc51e76 commit 887d219

File tree

3 files changed

+20
-101
lines changed

3 files changed

+20
-101
lines changed

README.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,23 @@
44

55
*Featured on the [Official GitHub Blog](https://github.com/blog/2292-game-off-iv-highlights)!*
66

7-
Copyright (c) 2007-2017 Grady O'Connell
7+
Copyright (c) 2007-2018 Grady O'Connell
88

99
Open-source under MIT License. See LICENSE file for more information.
1010

1111
See CREDITS.md for a list of contributers.
1212

1313
This is a rewrite of my [older game engine](https://github.com/flipcoder/qor-old), with code dating back to 2007.
1414

15-
## Instructions
16-
17-
- Read the documentation: [QorBook](https://github.com/flipcoder/qor/blob/master/QorBook.md)
15+
- [Project Board](https://trello.com/b/0uh8zbxa/qor)
16+
- [Documentation](https://gitlab.com/flipcoder/qor/blob/master/QorBook.md)
17+
- Projects and Examples:
18+
- [FRAG.EXE (First person shooter)](https://gitlab.com/flipcoder/FRAG.EXE)
19+
- [Micro Army (2d platformer)](https://gitlab.com/flipcoder/microarmy)
20+
- [Qorpse (2D shooter)](https://gitlab.com/flipcoder/qorpse)
21+
- [Skyroads-inspired racer](https://gitlab.com/flipcoder/bouncingship)
22+
- [C++ Usage Example](https://gitlab.com/flipcoder/qor/blob/master/src/DemoState.cpp)
23+
- [Python Usage Example](https://gitlab.com/flipcoder/qor/blob/master/bin/mods/scriptdemo/__init__.py)
1824

1925
## Features
2026

@@ -77,14 +83,6 @@ This is a rewrite of my [older game engine](https://github.com/flipcoder/qor-old
7783

7884
More features will be listed as I add them...
7985

80-
## Partial/WIP Features
81-
- Level-of-detail
82-
- Particle systems (rewriting this atm)
83-
- Shader selection based on mesh and material properties (almost done)
84-
- Better instancing
85-
- Python bindings are currently very limited
86-
- More documentation and user-friendliness
87-
8886
## Screenshots
8987

9088
[![Screenshot1](http://i.imgur.com/zQxsEfgl.jpg)](http://i.imgur.com/zQxsEfg.jpg)
@@ -93,13 +91,3 @@ More features will be listed as I add them...
9391

9492
[![Screenshot2](http://i.imgur.com/VPH9ZpCl.png)](http://i.imgur.com/VPH9ZpC.jpg)
9593

96-
97-
## Examples
98-
99-
- [FRAG.EXE (First person shooter)](https://github.com/flipcoder/FRAG.EXE)
100-
- [Micro Army (2d platformer)](https://github.com/flipcoder/microarmy)
101-
- [Qorpse (2D shooter)](https://github.com/flipcoder/qorpse)
102-
- [Skyroads-inspired racer](https://github.com/flipcoder/bouncingship)
103-
- [C++ Usage Example](https://github.com/flipcoder/qor/blob/master/src/DemoState.cpp)
104-
- [Python Usage Example](https://github.com/flipcoder/qor/blob/master/bin/mods/scriptdemo/__init__.py)
105-

templates/base/lib/submodules.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
If your project uses a git repository, add a submodule to Qor here:
2+
3+
```
4+
git submodule init
5+
git submodule add https://gitlab.com/flipcoder/qor Qor
6+
git submodule update --init --recursive
7+
```
8+
9+
Otherwise, copy or symlink the Qor folder here.
10+

templates/base/premake5.lua

Lines changed: 0 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -125,82 +125,3 @@ workspace("base")
125125
"`pkg-config --libs cairomm-1.0 pangomm-1.4`"
126126
}
127127

128-
project "test"
129-
kind "ConsoleApp"
130-
language "C++"
131-
links {
132-
"pthread",
133-
"GL",
134-
"GLU",
135-
"SDL2",
136-
"GLEW",
137-
"assimp",
138-
"freeimage",
139-
"openal",
140-
"alut",
141-
"ogg",
142-
"vorbis",
143-
"vorbisfile",
144-
"boost_system",
145-
"boost_thread",
146-
"boost_filesystem",
147-
"boost_python",
148-
"boost_coroutine",
149-
"boost_regex",
150-
"jsoncpp",
151-
"BulletSoftBody",
152-
"BulletDynamics",
153-
"BulletCollision",
154-
"LinearMath",
155-
"z",
156-
"RakNetDLL",
157-
}
158-
159-
-- Project Files
160-
files {
161-
"src/**.h",
162-
"src/**.cpp",
163-
"lib/Qor/Qor/**.h",
164-
"lib/Qor/Qor/**.cpp",
165-
"lib/Qor/lib/kit/**.h",
166-
"lib/Qor/lib/kit/**.cpp"
167-
}
168-
169-
-- Exluding Files
170-
excludes {
171-
"src/Main.cpp", -- run test suite instead
172-
173-
"lib/Qor/Qor/Main.cpp",
174-
"lib/Qor/Qor/Info.cpp",
175-
"lib/Qor/Qor/DemoState.*",
176-
--"lib/Qor/Qor/tests/**", -- don't exclude test suite
177-
"lib/Qor/Qor/scripts/**",
178-
"lib/Qor/Qor/addons/**",
179-
"lib/Qor/lib/kit/tests/**",
180-
"lib/Qor/lib/kit/toys/**"
181-
}
182-
183-
includedirs {
184-
"lib/Qor/",
185-
"lib/Qor/lib/kit",
186-
"/usr/local/include/",
187-
"/usr/include/bullet/",
188-
"/usr/include/rapidxml/",
189-
"/usr/include/raknet/DependentExtensions"
190-
}
191-
192-
libdirs {
193-
"/usr/local/lib",
194-
"/usr/local/lib64/",
195-
}
196-
197-
buildoptions {
198-
"`python2-config --includes`",
199-
"`pkg-config --cflags cairomm-1.0 pangomm-1.4`"
200-
}
201-
202-
linkoptions {
203-
"`python2-config --libs`",
204-
"`pkg-config --libs cairomm-1.0 pangomm-1.4`"
205-
}
206-

0 commit comments

Comments
 (0)