diff --git a/docs/credits.txt b/docs/credits.txt index 095e148c..222b7c52 100644 --- a/docs/credits.txt +++ b/docs/credits.txt @@ -5,7 +5,7 @@ Arghvark: Project Leader, Game Concept, Code, Prototyping -driAn : Lead Coder, Webdesign +driAn : Lead Coder makkE : Lead artist Models, Skins, Animations, Mapping, 2d-Art, some textures, Sound diff --git a/docs/docs.css b/docs/docs.css new file mode 100644 index 00000000..0fec303e --- /dev/null +++ b/docs/docs.css @@ -0,0 +1,158 @@ +@charset "utf-8"; + +body +{ + background-color: #343434; + font-family: Verdana, Sans-Serif; + margin: 0px; + padding: 10px 0 10px 0; + font-size: 12px; + color: Black; +} + +ul +{ + list-style-type:square; +} + +p +{ + margin-top: 0; + margin-bottom: 1em; +} + +img +{ + border-width: 0; +} + +pre +{ + margin: 0 0 1em 0; + padding: 0; + font-family: Courier New; + font-size: 12px; +} + +table +{ + margin-bottom: 1em; +} + +h1 +{ + font-size: 24px; + margin: 0 0 0.5em 0; +} + +h2 +{ + font-size: 18px; + margin: 0 0 0.5em 0; +} + +h3 +{ + font-size: 14px; + margin: 0 0 0.5em 0; +} + +#main +{ + background-color: #666666; + width: 650px; + margin: 0; + padding: 10px; + text-align: left; + border: solid 1px black; +} + +#header +{ + background-color: black; + width: 650px; + margin: 0px; + padding: 0; + height: 10px; + text-align: right; + font-size: 10px; + color: White; + font-family: Courier New, Sans-Serif; + line-height: 1em; +} + +#footer +{ + background-color: black; + width: 650px; + margin: 0; + padding: 0; + height: 10px; + text-align: right; + font-size: 10px; + color: White !important; + font-family: Courier New, Sans-Serif; + line-height: 1em; +} + +#footer a, #footer a:hover, #footer a:visited +{ + color: White; + text-decoration: none; +} + +a, a:hover, a:visited +{ + color: #333333; +} + +div.code +{ + font-family: Courier New, Sans-Serif; + margin: 1em 0 1em 0; + padding: 0 0 0 1em; +} + +span.code +{ + font-family: Courier, Sans-Serif; + margin: 0; + padding: 0; +} + + +/* guns */ + +table#guns td +{ + vertical-align: top; +} + +/* gunstats */ + +table#gunstats +{ + width: 100%; + border-collapse: collapse; +} + +table#gunstats thead td +{ + font-weight: bold; +} + +table#gunstats td +{ + border: solid 1px #777777; +} + + +/* items */ + +table.items td +{ + vertical-align: top; +} + + + diff --git a/docs/game.html b/docs/game.html new file mode 100644 index 00000000..92ecbcfc --- /dev/null +++ b/docs/game.html @@ -0,0 +1,354 @@ + + + + ActionCube README + + + + + + +
+ + +
+ +

The Game

+ +

Story

+ +

+ Well, there is no story. Bascially this game is about these two teams fighting each other: +

+ +

+ The Cubers Liberations Army (CLA)
+ + CLA + + Little is known about the goals and motivation of this small but feared Terrorist group. Their activities are + as diverse as their members. With ex-military, anarchists, religious fanatics, conspiracy theorists, hippies + stuck tripping, free© software fanatics™, or simply severely mental disordered persons or bored youngsters, this organization is a + pool for radicals from across the globe. Their operations range from simple annoyances (such as introducing + large amounts of mariuana-smoke into the air conditioners of offices or malls) to well planned gruesome + bombings, choosing civilians as well as politicians, lobbyists or religious leaders and their staff as + targets. “Terror for the sake of terror, for you all suck!” seems to be their motto. +

+ +

+ The Rabid Viper Special Forces (RVSF)
+ + RVSF + + An elite group of armed special forces, but not the kind you´d expect. These guys are battle worn fighters + and mercenairies, who might have been just a little too trigger happy and up for glory to fit into any other + kind of elite squad. Not suitable where lives are to be spared and private or public property to remain + unharmed. The backrounds and funders of this extravagant task-force remain well concealed, for obvious + reasons. Their primary targets are highly unpredictable terrorists and organized criminals such as the CLA + where intelligence, infiltration and stealth would be just a waste of time. “First shoot, then ask + questions, if anyone´s left to ask” is the primary approach to their job. +

+ +

Controls

+ +

+ This is the default controls setting: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
WMove forward
SMove backwards
ASidestep left
DSidestep right
SpaceJump
RReload
TChat and Console
Left MousebuttonAttack
Right MousebuttonUse scope (if you have the sniper rifle equipped)
MousewheelCycle weapons
1Primary weapon
2Pistol
3Grenade (if available)
4Knife
+ +

+ You can also assign custom keys to specific weapons. + Just modify the config/autoexec.cfg accordingly. Example: +

+ +
+ bind f "primary"
+ bind e "secondary"
+ bind c "melee"
+ bind q "grenade"
+
+ +

+ You will find suggestions for more ergonomical key setups in this config file. +

+ +

Weapons

+ +

+ There are seven weapons you can use to frag your enemies: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
knife + Swiss Tech Combat Blade DR-88
+

+ A sharp and swift blade. Your last ressort when you ran out of Ammo and your best friend + in humiliating snipers and campers. +

+
pistol + Mk-77 Semi-Automatic Pistol
+

+ You basic sidearm. A powerful resort weapon, yet typically less effective at range. + The small clip size is something you need to keep an eye on. +

+
assault + MTP-57 Assault Rifle
+

+ The large caliber deals a substantial amount of damage. A long barrel ensures accuracy even at high range. + It can become difficult to control when shooting bursts of more than three bullets. +

+
sniper + Precision Tech AD-81 Sniper Rifle
+

+ Semi Automatic Sniper rifle, equipped with a 2x Scope. The large caliber can do a frightful amount of damage. + Though naturally most accurate when used with the scope, the highly ergonomic design allows the experienced shooter to operate it from the hip as well. +

+
subgun + A-Ard 10 Submachine Gun
+

+ This one releases a deadly spray of bullets at a high rate of fire. + However, due to the short barrel and small caliber, + it´s manstopping power is limited, and effectiveness ceases at longer ranges. +

+
shotgun + V-19 Combat Shotgun
+

+ 8-round semi-automatic shotgun. This powerful weapon can shred your opponents to pieces- + if you´re close enough. +

+
grenade + SAL-T3 Grenade
+

+ This grenade is your friend in mid range fights. Its timer is adjusted to two seconds which makes it quite + useful for quick responses to your enemies fire bursts. +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
weapondamageattackdelayRPSdmg/secreloadmagsizebasemax
Swiss Tech Combat Blade DR-8850500ms2100----
Mk-77 Semi-Automatic Pistol20170ms5.91181400ms83280
MTP-57 Assault Rifle20130ms7.71542000ms206080
Precision Tech AD-81 Sniper Rifle721500ms0.6481950ms52020
A-Ard 10 Submachine Gun1780ms12.52131650ms3060120
V-19 Combat Shotgun1201000ms11202400ms72828
SAL-T3 Grenade1501200ms0.8125--02
+ +

+ Every player spawns with three weapons. + + Knife an pistol are the standard outfitting of every player, grenades must be picked up. + You can chose the primary weapon you want to use in the outfit menu (hotkey b). + + The next time you spawn, you will be given the primary weapon you chose. +

+ +

Items

+ +

+ There is a bunch of important items you can collect during the game: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Ammobox + Ammobox
+

+ This box supplies with ammo for the primary guns. The exact content: +

+
    +
  • 40 rounds for the assault rifle
    • +
  • 10 rounds for the sniper rifle
    • +
  • 60 rounds for the subgun
    • +
  • 14 shells for the shotgun
    • +
+

+ It respawns after 4, 6 or 8 seconds, depending on the number of players. +

+
Pistol Clips + Pistol Clips
+

+ This item adds 16 bullets to your pistol. It has the same respawn behavior as the ammobox. +

+
Akimbo + Akimbo
+

+ Picking this item lets you shoot with two pistols for 30 seconds. Take advantage of the crazy fire rate. + It as been reported that the respawn time is about one minute. +

+
Health + Health
+

+ This sweet health pack cures your damaged body with 33hp. The respawn time is between 10 and 20 seconds, + depending on the number of players. +

+
Kevlar + Kevlar
+

+ This one adds armour (50) to your equipment. The kevlar absorbs 30% of all damage and respawns every 20 seconds. +

+
Grenade + Grenade
+

+ Pick this to get two grenades into your pocket. +

+
+ +

Gamemodes

+ + ActionCube offers seven different game modes. You can vote for one of them using the menu: Press ESC and navigate to Multiplayer ⇒ Vote. + + + +
+ + +
+ + + diff --git a/docs/getstarted.html b/docs/getstarted.html new file mode 100644 index 00000000..0af12d83 --- /dev/null +++ b/docs/getstarted.html @@ -0,0 +1,106 @@ + + + + ActionCube README + + + + + +
+ + +
+ +

Prerequisites

+ +

Setting resolution

+ +

+ The default resolution is 1024x768. If you need to change it, modify actioncube.bat accordingly. +

+

+ -w sets width
+ -h sets height +

+ +

+ In linux, simply pass those parameters in the command line or add them to the actioncube.sh shell script. +

+ +

Setting your name

+

+ Open config/autoexec.cfg and search for the line +

+ +
name unarmed
+ +

+ replace unarmed with your own nickname. +

+ +

+ Hint: The autoexec.cfg provides comments and suggestions for further customization. +

+ +

Basics

+ +

Interface

+ +

+ In game, press ESC to access the main menu. From there you can do all sort of actions, like joining multiplayer games and changing settings. + As example, in the Team/Player Setup submenu, you can choose your team and skin. +

+ +

+ The menu covers the most important actions. Further customizations and actions can be done using CubeScript: To get a console + press T to open up the chat prompt. You can use it as console if you put a “/” (slash) at its beginning followed by a command. + As example, type this into the console: +

+ +
+ /crosshairsize 25 +
+ +

+ This will increase the size of your crosshair. All changes done by the menu or using this console will be lost once you quit the game. + To store such settings for good, make your customizations in config/autoexec.cfg. +

+ +

Joining a Game

+ +

+ In game, press ESC and choose Multiplayer ⇒ Refresh Server List. The masterserver will be queried and provide you with a list of servers. + Do so every few days, to add newly created servers to your list. +

+ +

+ Once you updated your server list, you can use Multiplayer ⇒ Serverbrowser. + Simply select a server (up-/downarrow) and press return. +

+ +

+ Alternatively, you can connect to a server directly using this command: +

+ +
+ connect N +
+ +

+ Where N is a valid IP or FQDN. +

+ +

Read on

+ +

+ Continue reading in the game section to find out how to obtain different weapons, how the controls are set, etc. +

+ +
+ + +
+ + + diff --git a/docs/history.html b/docs/history.html new file mode 100644 index 00000000..79b62703 --- /dev/null +++ b/docs/history.html @@ -0,0 +1,22 @@ + + + + + ActionCube: + + + + + +
+ +
+ + + +
+ +
+ + + diff --git a/docs/iefix.js b/docs/iefix.js new file mode 100644 index 00000000..a32063b3 --- /dev/null +++ b/docs/iefix.js @@ -0,0 +1,44 @@ +// well, this readme requires javascript to fix a dumb IE bug, sorry + +function correctPNG() // correctly handle PNG transparency in Win IE 5.5 or higher. +{ + for(var i=0; i" + img.outerHTML = strNewHTML + i = i-1 + } + } +}; + +if(navigator.appName == "Microsoft Internet Explorer") +{ + var ID = "MSIE"; + var versionIndex = navigator.appVersion.indexOf(ID); + if(versionIndex >= 0) + { + versionIndex += ID.length + 1; + var version = navigator.appVersion.substr(versionIndex, 3); + + if(version == "5.5" || version.substr(0,1) == "6") + { + window.attachEvent("onload", correctPNG); + } + } +}; + + diff --git a/docs/known_issues.txt b/docs/known_issues.txt index 3a30a8f9..a4f7e6fb 100644 --- a/docs/known_issues.txt +++ b/docs/known_issues.txt @@ -1,6 +1,7 @@ known issues: -- the sourcecode is messed up -- bots do not use the akimbo and grenades +- the sourcecode is messed up (TM) +- the documentation sucks +- bots do not use the akimbo and grenades... and ladders - demo recording is disabled - bot waypoints are only very basic. \ No newline at end of file diff --git a/docs/misc.html b/docs/misc.html new file mode 100644 index 00000000..4132e4b5 --- /dev/null +++ b/docs/misc.html @@ -0,0 +1,80 @@ + + + + ActionCube: Misc + + + + + +
+ + +
+ +

Misc

+ +

Crosshair

+ +

+ You can change your crosshair temporarly using the menu Team/Player Setup ⇒ Change Crosshair. However, to change + it permanently you need to +

+ +
    +
  1. open your config/autoexec.cfg
    2. +
  2. search for the line loadcrosshair default.png
    3. +
  3. replace default.png with the filename of one of the images in packages/misc/crosshairs
    4. +
  4. save the file
    5. +
+ +

+ To change the size of your crosshair, search for this line in the same configuration file as above. +

+ +
+ crosshairsize 15 +
+ +

+ Simply try a different value instead of 15. +

+ + +

Gib tuning

+ +

+ If you like excessive blood and the like, you might want to tune the gibs a bit: +

+ +
+ gibnum N +
+ +

+ Sets the number of gibs that spawn on a gib-worthy kill. Defaults to 6 and is limited to 1000. Do not blame us if your poor box freezes due to a gib flood. +

+ +
+ gibspeed N +
+ +

+ Sets the velocity of the gibs. Defaults to 5 and is limited to 20. +

+ +
+ gibttl N +
+ +

+ Sets the lifetime in milliseconds for the gibs. Defaults to 5000 and is limited to 15000. +

+ +
+ + +
+ + + diff --git a/docs/package_copyrights.txt b/docs/package_copyrights.txt index db11b1c7..98b0b5ea 100644 --- a/docs/package_copyrights.txt +++ b/docs/package_copyrights.txt @@ -3,7 +3,7 @@ This file holds the copyright information for all packages/artwork included in A --------------MAPS------------------- Copyright (c) 2004-2006 by makkE (makk_e@web.de),Arghvark, MitaMan - The maps included remain interlectual property of their respective creators. + The maps included remain intellectual property of their respective creators. Mapmessages upon load will provide further detail. --------------MODELS------------------------------------------------------------------------ @@ -136,7 +136,7 @@ Note: Shame on me I didn ---------Music------------- -Main Menu Loop: (c) 2005 dietmar pier created for Actioncube, all rights reserved. +Main Menu Loop: (c) 2005 Dietmar Pier, created for ActionCube, all rights reserved. cube.dietmarpier.de diff --git a/docs/ctf-hud.jpg b/docs/pics/ctf-hud.jpg similarity index 100% rename from docs/ctf-hud.jpg rename to docs/pics/ctf-hud.jpg diff --git a/docs/pics/flag_cla.png b/docs/pics/flag_cla.png new file mode 100644 index 00000000..5ef5583b Binary files /dev/null and b/docs/pics/flag_cla.png differ diff --git a/docs/pics/flag_rvsf.png b/docs/pics/flag_rvsf.png new file mode 100644 index 00000000..e9d65135 Binary files /dev/null and b/docs/pics/flag_rvsf.png differ diff --git a/docs/pics/item_akimbo.png b/docs/pics/item_akimbo.png new file mode 100644 index 00000000..d584bd7e Binary files /dev/null and b/docs/pics/item_akimbo.png differ diff --git a/docs/pics/item_ammobox.png b/docs/pics/item_ammobox.png new file mode 100644 index 00000000..69dfd1db Binary files /dev/null and b/docs/pics/item_ammobox.png differ diff --git a/docs/pics/item_grenade.png b/docs/pics/item_grenade.png new file mode 100644 index 00000000..df1c15f9 Binary files /dev/null and b/docs/pics/item_grenade.png differ diff --git a/docs/pics/item_health.png b/docs/pics/item_health.png new file mode 100644 index 00000000..dc592785 Binary files /dev/null and b/docs/pics/item_health.png differ diff --git a/docs/pics/item_kevlar.png b/docs/pics/item_kevlar.png new file mode 100644 index 00000000..a2362261 Binary files /dev/null and b/docs/pics/item_kevlar.png differ diff --git a/docs/pics/item_pistolclips.png b/docs/pics/item_pistolclips.png new file mode 100644 index 00000000..3b4893de Binary files /dev/null and b/docs/pics/item_pistolclips.png differ diff --git a/docs/pics/weapon_assault.png b/docs/pics/weapon_assault.png new file mode 100644 index 00000000..c07ad63e Binary files /dev/null and b/docs/pics/weapon_assault.png differ diff --git a/docs/pics/weapon_grenade.png b/docs/pics/weapon_grenade.png new file mode 100644 index 00000000..71950255 Binary files /dev/null and b/docs/pics/weapon_grenade.png differ diff --git a/docs/pics/weapon_knife.png b/docs/pics/weapon_knife.png new file mode 100644 index 00000000..c8f76933 Binary files /dev/null and b/docs/pics/weapon_knife.png differ diff --git a/docs/pics/weapon_pistol.png b/docs/pics/weapon_pistol.png new file mode 100644 index 00000000..1027362c Binary files /dev/null and b/docs/pics/weapon_pistol.png differ diff --git a/docs/pics/weapon_shotgun.png b/docs/pics/weapon_shotgun.png new file mode 100644 index 00000000..68d16c32 Binary files /dev/null and b/docs/pics/weapon_shotgun.png differ diff --git a/docs/pics/weapon_sniper.png b/docs/pics/weapon_sniper.png new file mode 100644 index 00000000..09a351e0 Binary files /dev/null and b/docs/pics/weapon_sniper.png differ diff --git a/docs/server.html b/docs/server.html new file mode 100644 index 00000000..485419b9 --- /dev/null +++ b/docs/server.html @@ -0,0 +1,79 @@ + + + + + ActionCube README + + + + + +
+ + +
+ +

+ Setting up a Server +

+ +

Command Line Options

+ +

+ In the file actioncube_server.bat (or the respective .sh file in linux) you can add or + change command line options. The possible command line options can be optained from the + cube config documentation. + ActionCube behaves mostly like Cube, there are a few differences though: +

+ +
    +
  • Unline cube, ActionCube uses the ports 28764 and 28766 (UDP)
    • +
  • +

    + There is the additional command line option -r to specify a maprotation file: +

    +
    + -rconfig/maprot.cfg +
    +

    + See chapter maprotation below for more information. +

    +
    • +
+ +

Maprotation

+ +

+ In the maprotation file specified on the command line (default: config/maprot.cfg), you can specify + the map, mode, time and voting for your server. Each line defines one round. Example: +

+ +
+// server side maprotations
+// WARNING: You can NOT use CubeScript in there
+// use the following scheme:
+// map:mode:time:allowVote
+
+// tdm
+ac_complex:0:10:1
+ac_depot:0:10:1
+ac_desert:0:10:1
+ac_mines:0:10:1
+
+// ctf
+ac_mines:5:10:1
+ac_depot:5:10:1
+
+ +

+ The first line, ac_complex:0:10:1, means, the map ac_complex is played + in mode 0 (Team Deathmatch) for 10 minutes. The connected players are allowed to vote. +

+ +
+ + +
+ + +