about summary refs log tree commit diff
path: root/docs/articles
diff options
context:
space:
mode:
authorMagnus Auvinen <magnus.auvinen@gmail.com>2007-05-22 15:06:55 +0000
committerMagnus Auvinen <magnus.auvinen@gmail.com>2007-05-22 15:06:55 +0000
commit9ba8e6cf38da5196ed7bc878fe452952f3e10638 (patch)
treeea59837e22970274abac0ece2071e79189256901 /docs/articles
parent90bcda3c10411ee4c1c65a494ec7c08dfdea01b4 (diff)
downloadzcatch-9ba8e6cf38da5196ed7bc878fe452952f3e10638.tar.gz
zcatch-9ba8e6cf38da5196ed7bc878fe452952f3e10638.zip
moved docs
Diffstat (limited to 'docs/articles')
-rw-r--r--docs/articles/editor.txt37
-rw-r--r--docs/articles/gameplay.txt15
-rw-r--r--docs/articles/hacking.txt8
-rw-r--r--docs/articles/map_format.txt100
-rw-r--r--docs/articles/people.txt23
-rw-r--r--docs/articles/playing.txt13
-rw-r--r--docs/articles/tasks.txt39
7 files changed, 235 insertions, 0 deletions
diff --git a/docs/articles/editor.txt b/docs/articles/editor.txt
new file mode 100644
index 00000000..d1710103
--- /dev/null
+++ b/docs/articles/editor.txt
@@ -0,0 +1,37 @@
+Title: Editor
+
+Group: Layout
+(start code)
+.----------------------------------------.
+| File Edit View                         |  < Menu bar
++--------+-------------------------------+
+| Layer1 |                               |
+| Layer2 |                               |
+| Layer3 |                               |
+|        |                               |
++--------+                               | < Main view
+|        |                               |
+| Prope- |             ###               |
+| rties  |#     ###                      |
+|        |##     ##           ##         |
+|        |#                   ###########|
+|        |###############################|
++--------+-------------------------------+
+| Status Bar                             | < Status bar
+'----------------------------------------'
+(end)
+
+Group: Brush
+* To select a brush, you either click a tile or drag a box
+to select a set of tiles to use as your brush.
+* When you have a brush you just click to paint with it.
+* To empty your brush, you tap space, and then you can select
+a new one.
+
+Group: The tileset
+* Holding space down for longer then 150ms (TBD) will show the
+current tileset.
+
+Group: Keyboard layout
+Space (tap) - Clear brush
+Space (hold) - Show tileset
diff --git a/docs/articles/gameplay.txt b/docs/articles/gameplay.txt
new file mode 100644
index 00000000..726ee69b
--- /dev/null
+++ b/docs/articles/gameplay.txt
@@ -0,0 +1,15 @@
+Title: Gameplay
+
+Group: Weapons
+Gun - No reload, fast fire times
+Rocket/Grenade launcher - ...
+Sniper - The game source. This is the source that acctually is teewars. 
+	You can write a new game using the engine by removing these files and start from scratch.
+scripts - Scripts.
+
+
+Group: Powerups
+Ninja - Katana, slash stuff in your way
+Timefield - Everything around you slows down/completly stops?
+Health - yeah...
+Armor - yeah...
\ No newline at end of file
diff --git a/docs/articles/hacking.txt b/docs/articles/hacking.txt
new file mode 100644
index 00000000..a9dc23ac
--- /dev/null
+++ b/docs/articles/hacking.txt
@@ -0,0 +1,8 @@
+Title: Hacking
+
+Group: Source Layout
+data_src - Data for the game is located under data_src and is unprocessed.
+src - Engine source. It contains the network communication, graphics and sound.
+src/game - The game source. This is the source that acctually is teewars. 
+	You can write a new game using the engine by removing these files and start from scratch.
+scripts - Scripts.
diff --git a/docs/articles/map_format.txt b/docs/articles/map_format.txt
new file mode 100644
index 00000000..7583a5b7
--- /dev/null
+++ b/docs/articles/map_format.txt
@@ -0,0 +1,100 @@
+Title: Map File Format
+
+Group: Structure
+(start code)
+int ID // should be "MAPP"
+int version // should be 2
+int size
+int swaplen
+	
+int num_item_types
+int num_items
+int num_raw_data
+	
+int item_size
+int data_size
+
+types {
+	int typeid
+	int start
+	int num
+} * (num_item_types)
+
+item_offsets {
+	int offset
+} * (num_items)
+	
+raw_data_offsets {
+	int offset
+} * (num_raw_data)
+
+item {
+	int type_and_id
+	int size
+	datai {
+		int data
+	} * (size/4)
+} * (num_items)
+
+raw_data {
+	byte d
+} * X
+(end)
+
+Notes:
+	* swaplen tells how much of the data that should be swapped
+	* types.start is an index into offsets
+	* item.size must be a multiple of 4
+	* the types must be sorted by type id
+	* special typeid of 0xffff means raw data, and there fore should always come last
+
+Could change:
+	* item.size could be removed
+
+Section: Registered Item Types
+
+Group: Image (0x8010)
+(start code)
+image {
+	int width
+	int height
+	int raw_data_index
+}
+
+pixel_data {
+	byte r
+	byte g
+	byte b
+	byte a
+} * (width * height)
+(end)
+
+Group: Tilemap (0x8020)
+(start code)
+tilemap {
+	int image
+	int width
+	int height
+	int x
+	int y
+	int scale
+	int raw_data_index
+}
+
+data {
+	byte data
+} * (width * height)
+(end)
+
+Group: Collision (0x8030)
+(start code)
+collision {
+	int width
+	int height
+	int raw_data_index
+}
+
+data {
+	byte data
+} * (width * height)
+(end)
diff --git a/docs/articles/people.txt b/docs/articles/people.txt
new file mode 100644
index 00000000..20f58cc8
--- /dev/null
+++ b/docs/articles/people.txt
@@ -0,0 +1,23 @@
+Title: People
+
+Group: Magnus Auvinen (matricks)
+* *Role*: Lead Programmer
+* *Email*: magnus.auvinen@gmail.com
+* *Likes*: Tight stuff
+* *Dislikes*: Memory allocation
+
+Group: Johan Althoff (teetow)
+* *Role*: Lead Designer, Sound Designer
+* *Email*: teetow@gmail.com
+* *Likes*: Cute 'n cuddly
+* *Dislikes*: Booring food
+
+Group: Tomas Landin (kungtotte)
+* *Role*: Win32 Maintainer
+* *Email*: kungtotte@gmail.com
+
+Group: Joel de Vahl (void)
+* *Role*: Mac OS X Maintainer
+* *Email*: joel.de.vahl@gmail.com
+* *Likes*: Weird programming languages
+* *Dislikes*: Monoculture
diff --git a/docs/articles/playing.txt b/docs/articles/playing.txt
new file mode 100644
index 00000000..34ed40ce
--- /dev/null
+++ b/docs/articles/playing.txt
@@ -0,0 +1,13 @@
+Title: Playing
+
+Group: Starting a Server
+(start code)
+# ./teewars -s
+(end)
+
+Group: Connecting with the client
+(start code)
+# ./teewars [-c IP]
+(end)
+
+Not specifying -c will connect the client to localhost.
diff --git a/docs/articles/tasks.txt b/docs/articles/tasks.txt
new file mode 100644
index 00000000..2b86dcef
--- /dev/null
+++ b/docs/articles/tasks.txt
@@ -0,0 +1,39 @@
+Title: Tasks
+
+Group: 0.1.0 - Awesome Alpha (RELEASED)
+
+Group: 0.1.1 - Awesome Alpha Bug Fixed (NEXT)
+	DONE * Bobbing powerups
+	DONE * Get -c working under windows
+	DONE * Bigger powerups
+* Pickup sounds
+* FAQ on the webpage
+	DONE * Private server (no heartbeats)
+	DONE * Can't pickup ammo, health or armor when not needed
+
+Group: 0.2.x - 
+* Fix so that the homepage is in the SVN
+* Cleanup: SVN
+* Cleanup: client.cpp / server.cpp
+* Cleanup: game_client.cpp / game_server.cpp
+* Cleanup: editor.cpp
+* Masterserver: Master server should only hold ips. Clients should ask servers for more info + ping
+* Masterserver: NAT/FW detection
+* Game: Respawn time
+* Game: Chat
+* Game: Bigger and better scoreboard
+* Game: Events for kills and such
+* Client: Should timeout from server
+* Client: More robust and smoother handling of snapshots
+* Client: Some sort of settings format (think KISS).
+* Server: LAN / Internet / Private servers.
+* Server: Answer to a getinfo message
+
+Group: 0.3.0 - Editor Edition
+* Fix the editor
+
+Group: Unassigned
+* zlib compression on the maps.
+* png loader
+* The gfx API now uses BGRA for texture loading. It should be RGBA. (gfx.cpp)
+* Flipping of tiles in the tilemap should be fixed. (mapres_tilemap.cpp)