diff --git a/README.html b/README.html deleted file mode 100644 index 18f8ab49..00000000 --- a/README.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - ActionCube README - - - - - - - -
- - - -
- -

ActionCube v0.92 (BETA)

- -

About

- -

- ActionCube is a total conversion of Wouter van Oortmerssen´s FPS called Cube. - Set in a realistic looking environment, as far as that´s possible with this engine, while gameplay stays fast and arcade. - This game is all about team oriented multiplayer fun. -

- -

Readme

- -

- Basic sections: -

- - - -

- Advanced sections: -

- - - - -

- Check out the following files for further information: -

- - - - -

Contact and Help

- -

- Please do not ask ActionCube specific stuff on the cube forums, please use one of the following possibilities - instead: -

- - - -

- Before you ask for help you should read this readme and check out the FAQ on - the official website. Thank you. -

- - -

Authors

- -

Rabid Viper Productions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Andrew “Arghvark” DavisProject Leader, Game Concept, Code
Adrian “driAn” HenkeLead Coder
Markus “makkE” BekelLead artist, Models, Skins, Animations, Mapping, 2d-Art, some textures, Sound
Shane NiebModels
MitamanMaps, Ressources
Elliot “Verbal_” LockwoodQA, Advisor, Lead Tester, pro-coffee service
Lee “eihrul” SalzmanCoder, Enet Library, Cube2 backporting
- -

Thanks to

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Wouter “Aardappel” van Oortmerssen and othersThe Cube Game/Engine
Lee “Eihrul” SalzmanEnet Library
Rick HelmusBot Code
Julian “absinth” MayerPackaging ActionCube for Mac
Paul “JCDPC” CashLaptop Model, Company
Dietmar “DCP” PierSoundtrack
Zac “dtd” JarcoHosting
- -

- Thanks to kurtis84, player1, quase and some others for testing. -

- -

Texture sources

- - - - -

License

- -

- ActionCube is freeware, you may freely distribute the ActionCube installer/archive unmodified on any media. - ActionCube is distributed WITHOUT WARRANTY, you may use it for any purpose as long as you do not blame us for any - damages incurred. -

- -

- As this game consists of different packages with different licenses, see these files in your ActionCube installation - for additional information: -

- - - -
- - - -
- - - diff --git a/docs/README.xml b/docs/README.xml new file mode 100644 index 00000000..6c7d2af7 --- /dev/null +++ b/docs/README.xml @@ -0,0 +1,246 @@ + + + + + + + +

About

+ +

+ AssaultCube is a total conversion of Wouter van Oortmerssen´s FPS called Cube. + Set in a realistic looking environment, as far as that´s possible with this engine, while gameplay stays fast and arcade. + This game is all about team oriented multiplayer fun. +

+ +

+ This README consists of these sections: +

+ + + +

Documentation

+ +

Basics

+ + + +

Advanced

+ + + + + +

Online Resources

+ +

+ The AssaultCube Wiki contains additional documentation created by + the community. +

+ +

Help!

+ +

If you need help when running AC, follow these steps:

+ +
    +
  1. + Search this documentation for a solution, make sure you read the Basics sections +
  2. +
  3. + Browse the AC wiki, + especially its FAQ might help +
  4. +
  5. + Visit the forum and use its search functionality. + If you don't find any useful stuff, post a detailed question there. Please respect the forum + rules.. +
  6. +
+ +

+ Instead of posting to the forum, you can also ask the people in our IRC channel, #AssaultCube on Quakenet +

+ +

Contribute

+ + + +

Authors

+ +

Rabid Viper Productions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Andrew “Arghvark” Davis + Project Leader, Game Concept, Code
+ Adrian “driAn” Henke + Lead Coder
+ Markus “makkE” Bekel + Lead artist, Models, Skins, Animations, Mapping, 2d-Art, some textures, Sound
Shane NiebModels
MitamanMaps, Ressources
+ Elliot “Verbal_” Lockwood + QA, Advisor, Lead Tester, pro-coffee service
+ Lee “eihrul” Salzman + Coder, Enet Library, Cube2 backporting
+ +

Thanks to

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Wouter “Aardappel” van Oortmerssen and othersThe Cube Game/Engine
Lee “Eihrul” SalzmanEnet Library
Rick HelmusBot Code
Julian “absinth” MayerPackaging AssaultCube for Mac
Paul “JCDPC” CashLaptop Model, Company
Dietmar “DCP” PierSoundtrack
Zac “dtd” JarcoHosting
+ +

+ Thanks to kurtis84, player1, quase and some others for testing. +

+ +

License

+ +

+ AssaultCube is freeware, you may freely distribute the AssaultCube installer/archive unmodified on any media. + You may re-compress using different archival formats (i.e. zip/tgz/rpm/deb/dmg), + any changes beyond that require explicit permission. +

+

+ AssaultCube is distributed WITHOUT WARRANTY, you may use it for any purpose as long as you do not blame us for any + damages incurred. +

+ +

+ As this game consists of different packages with different licenses, see these files in your AssaultCube installation + for additional information: +

+ + + + \ No newline at end of file diff --git a/docs/ac.css b/docs/ac.css new file mode 100644 index 00000000..13b179e2 --- /dev/null +++ b/docs/ac.css @@ -0,0 +1,127 @@ +/* ZLIB licensed, (C) 2007 Adrian 'driAn' Henke, http://www.sprintf.org */ +/* common styles for all AC xhtml documentation pages */ + + +/* main layout */ + +html +{ + margin: 0; + padding: 0; + background-color: #343434; /* firefox xslt bug */ +} + +body +{ + margin: 0; + padding: 10px; + font-family: Verdana, Sans-Serif; + font-size: 12px; +} + +div#main +{ + position: relative; + margin: 0 auto 0 auto; + width: 740px; +} + +div#main div#title +{ + margin: 0 auto 0 auto; + padding: 0 10px 0 10px; + height: 20px; + background-color: Black; + color: White; + vertical-align: middle; + border-left: solid 10px #343434; + border-right: solid 10px #343434; +} + +div#main div#title h1 +{ + margin: 0; + padding: 0; + height: 1em; + font-family: Courier New, Sans-Serif; + font-size: 18px; + font-weight: bold; +} + +div#main div#content +{ + padding: 10px; + /*padding-top: 0px; /* fix first h1 child margin */ + border: solid 1px black; + background-color: #666666; +} + +div#main div#footer +{ + padding: 0 10px 0 10px; + height: 20px; + text-align: right; + color:White; + background-color: Black; + border-left: solid 10px #343434; + border-right: solid 10px #343434; + font-family: Courier New, Sans-Serif; +} + +/* version */ + +div#main div#version +{ + padding: 0; + margin: 0 auto 0 auto; + width: 720px; + + font-family: Courier New, Sans-Serif; + font-size: 55px; + font-weight: bold; + text-align: right; + color: #555555; +} + + +/* default formatting */ + +h1 +{ + font-family: Courier New, Sans-Serif; + font-size: 22px; + /*margin: 10px 0 10px 0; + padding: 0;*/ +} + +h2 +{ + font-family: Courier New, Sans-Serif; + font-size: 18px; + /*margin: 10px 0 10px 0; + padding: 0;*/ +} + +h3 +{ + font-family: Courier New, Sans-Serif; + font-size: 16px; + /*margin: 10px 0 10px 0; + padding: 0; */ +} + +a, a:hover, a:visited +{ + color: #333333; +} + +p +{ + padding: 0; + margin: 10px 0 10px 0; +} + +ul +{ + list-style-type:square; +} \ No newline at end of file diff --git a/docs/config.html b/docs/config.html deleted file mode 100644 index 95d5d26c..00000000 --- a/docs/config.html +++ /dev/null @@ -1,419 +0,0 @@ - - - - ActionCube README - - - - - -
- - -
- -

Configuration

- - - -

Command-Line Options

- -

- In the file actioncube_server.bat (or the respective .sh file in linux) you can add or - change command line options: -

- -

- -wX sets desired screen width to X, default is -w640 -
- -hY sets desired screen height to Y, default is -h480 -
- -t runs windowed -

-

- -uN sets the server upstream bandwidth to N bytes per second. only set - this parameter if you know what you are doing, specifying a wrong value is worse - than not specifying it at all. -

-

- -nN sets the server description, for people pinging the server. usually - does not need to be set if you have a descriptive domain name already, but if you - set it, keep it short as it may otherwise be truncated, i.e. -nBobsInstagibServer - -

-

- -iIP sets the server ip to IP. this option is only useful for people - running on machines with multiple network interfaces. -

-

- -mM sets the master server to use for either server (registering) and - client (updating) to M. M is the base url of the master server and has to end in - a / and without a http:// prefix, the default is masterserver.cubers.net/cgi-bin/actioncube.pl/. - If you want your server to be private and not report to the masterserver, use -mlocalhost. -

-

- -pPASS sets the server password to PASS. Only clients that use the command - "password PASS" will be able to connect. -

-

- -cN sets the maximum number of players that can play on this server - to N (default 6). If more players try to connect they will get a "server full" message. -

- -

- -xM sets the master password. -

-

- -rC sets the maprotation file, e.g. -rconfig/maprot.cfg -

- - - -

General console commands and configuration

- -
- bind K A -
- - binds key K to commands A (see console language below for what you can put in A). To find out what key names and their default bindings are, look at data/keymap.cfg, then add bind commands to your autoexec.cfg. - -
- alias N A -
- - binds name N to commands A, after which you can use N as a shortcut for A. You may re-bind N as often as you like, and bind N again within the execution of A etc. - -
- quit -
- - quits without asking. - -
- forward / backward / left / right -
- - move you in said direction (defaults to cursor keys). - -
- attack -
- - fires the current weapon. default = left mouse - -
- jump -
- - triggers a jump. default key space & right mouse. - -
- invmouse B -
- - sets mouse to "flight sim" mode if B is not 0 - -
- sensitivity S -
- - sets mouse sensitivity (see autoexec.cfg). with sensitivityscale you can specify a number that the sensitivity is divided by. - -
- fov N -
- - sets your FOV to 10..120. - -
- minmillis N -
- - Sets the minimum number of milliseconds a frame should take. This is for very fast machines that run Cube at hundreds of fps. Default is 5, i.e. try to stay close to 200fps. This command is not exact, i.e. the precise delay it generates depends on OS and other factors... experiment with your ideal setting. To turn it off, simply set it to 0. - -
- fog N -
- - sets fog distance to N (default currently 160). You can do this for tweaking the visual effect of the fog, or if you are on a slow machine, setting the fog to a low value can also be a very effective way to increase fps (if you are geometry limited). Try out different values on big maps / maps which give you low fps. - -
- fogcolour C -
- - Sets fog and clearing colour to C, the default being 0x8099B3. This and the fog variable can be set in the map specific .cfg file. - -
- dynlight R -
- - determines wether dynamic shadows & lights are rendered, providedjust incase they slow your fps down too much. With radius you can specify the radius of a dynamic light (default 16), smaller to maybe gain some speed (0 is off entirely), or bigger to see the effect of dynamic shadows more dramatically (try shooting it past some pillars that have a dark area on the other side... or use the "gamespeed" variable). - -
- lighterror E -
- - Allows you to finetune the amount of "error" the mipmapper/stripifier allow themselves for changing lightlevels. Set to 1 for maximum light quality at the expense of fps, set to some high value to gain fps but with messier lighting (only helps if you are geometry limited). Default = 8. If you change this during play, you have to do a "recalc" to see the effect. - -
- watersubdiv N -
- - determines the subdivision of the water surface in maps, which can greatly affect fps on slow machines. Must be a power of 2: 4 is the default, 8 is recommended for people on slow machines, 2 is nice for fast machines, and 1 is quite OTT. See "waterlevel" (edit reference) on how to add water to your own levels. - -
- maxparticles N -
- - Sets the maximum number of particles rendered at any one time. If more particles are generated than this number, the oldest ones are culled, so you can safely set this number relatively low without loss of information. default 1000. - -
- screenshot -
- - writes out "screenshots/screenshotN.bmp", where N is the number of milliseconds since cube was launched (default key = F12). - -
- musicvol n
- soundvol n -
- - sets the music/sound volume from 0 to 255 - -
- soundbufferlen n -
- - (default 512) tweak this if you experience stuttering or lagging sound - -
- gamma n -
- - sets the hardware gamma value to n percent (default 100). May not work if your card/driver doesn't support it. - -
- hidestats b -
- - turns on/off display of fps/rendering stats on the HUD (default = 1). - -
- maxroll n -
- - sets the maximum value your display will roll on strafing (0..20, default = 3) - -
- crosshairsize n -
- - sets the size of your crosshair, 0 being off (default = 3) - -
- crosshairfx b -
- - turns on or of crosshair effects (default 1). when on, the crosshair will go grey when the weapon is reloading, orange when health <= 50, or red when <=25. - -
- exec C -
- - executes all commands in config file C. - -
- newmenu N -
- - creates a new menu with name N. All following menuitem commands will apply to this menu - -
- menuitem N A
- menuitem A -
- - creates a new menuitem with description N and action A. if you only specify 1, then it will be used for both the description and the action. See data/menus.cfg for examples. - -
- showmenu N -
- - displays the menu with name N previously defined, and allows the user to pick an item with the cursor keys. Upon pressing return, the associated action will be executed. pressing ESC will cancel the menu. - -
- history N -
- - Executes the Nth command in the command line history. For example, binding "history 0" to a key allows you to quickly repeat the last command typed in (useful for placing many identical entities etc.) - -
- keymap K N A -
- - sets up the keymap for key code K with name N and default action A. You should never have to use this command manually, use "bind" instead. - -
- lightscale N -
- - used to finetune the "overbright lighting" rendering feature when enabled: lower numbers make the scene brighter, default = 4. After changing this value, you need to use "recalc" to see the differences. - -
- particlesize P -
- -

- scales all particles by percentage P. -

- -

- To use overbright lighting, your card needs to support the "EXT_texture_env_combine" extension (Nvidia from TNT1 and upwards, ATI from rage128/radeon and upwards, but not on voodoos afaik). Overbright lighting uses a different lighting model (lights that overlap "add" rather use the biggest of the two, and lightsources have an exponential rather than linear model), so lighting may look different depending on how the mapper placed the lights. Maps should be made with additive/exponential lighting in mind, however, because soon everyone will have a card that supports this extension. -

- -

- Do not confuse "lightscale" with "gamma", they have different effects. It is best to leave "lightscale" at the default and tune gamma to get the right brightness level for your situation, but you can tune the other way around if you find the saturation level of a certain gamma level more important. changing the lightscale will have an effect on the distribution of lightsources (higher lightscale will make them more like spotlights). Generally, gamma needs to be lower compared to older cube releases. -

- -

Console Language

- -

- Cube's console language is similar to console languages of other games (e.g. Quake), but is a bit more powerful in - that it is almost a full programming language. -

- -

- What is similar to quake is the basic command structure: commands consist of the command itself, followed by any - number of arguments seperated by whitespace. you can use "" to quote strings with whitespace in them (such as the - actions in bind/alias), and whereever a command is required you can also use ; to sequence multiple commands in one. -

-

- What is new compared to quake is that you can evaluate aliases and expressions. You can substitute the value of an - alias as an argument by prefixing it with a "$" sign, i.e.: echo The current value of x is $x - You can even substitute - the values of console variables this way, i.e $fov gives the current fov. Some aliases are set automatically, for - example $arg1 to $argN are set if you supply arguments when you execute an alias. -

-

- There are two alternative ways to "" to quote a string: () and []. They work in the same way as "", with the difference - that they can be nested infinitely, and that they may contain linefeeds (useful for larger scripts). () is different - from [] in that it evaluates the commands contained in it _before_ it evaluates the surrounding command, and substitutes - the results. () bracketed strings are called expressions, and combined with some commands made especially for - "programming", you have a minimal language: -

- -
- + A B
- - A B
- * A B
- div A B
- mod A B
-
- - (add, substract, multiply, divide, modulo): these all work like the integer operators from other languages.
- Example: echo x squared is (* $x $x) - -
- = A B
- < A B
- > A B
- strcmp A B
-
- - (equals, lessthan, greaterthan, stringcompare): comparison operators that return 1 for true and 0 for false. - -
- if cond true false -
- - executes the true or false part depending on wether cond is "0" or something else.
- Example: if (< $x 10) [ echo x is $x ] [ echo x is too big ] - -
- loop N body -
- - evaluates body N times, and sets the alias "i" from 0 to N-1 for every iteration.
- Example: loop 10 [ echo $i ] - -
- while cond body -
- - evaluates body while cond evaluates to true. Note that cond here has to have [], otherwise it would only be evaluated once.
- Example (same as the loop): alias i 0; while [ (< $i 10) ] [ echo $i; alias i (+ $i 1) ] - -
- concat S... -
- - concatenates all the arguments into alias "s" - -
- concatword S... -
- - same as concat but without spaces between the elements. - -
- at S N -
- - grabs the Nth word out of string S and puts it into alias "s" - -
- onrelease A -
- - only executes A if the command is executed on the release of a key/button (must be in an action in a bind or an alias in a bind). - -
- sleep N C -
- - executes command C after N milliseconds have passed. only one command can be sleeping at any one time. gets reset at map load. - -
- (millis) -
- - returns the number of milliseconds since engine start. - - variables that are only really useful when used as value: - -
- $editing -
- - true when in edit mode - -
- $flrceil -
- -

- 0 when the player looks at the floor, and 2 when looking at the ceiling. -

- -

How The Cube Engine Works

- -

- The cube engine is simplicity itself. The whole map consists of a large 2D array of "cubes", each with a floor and ceiling height, textures (for floor/ceiling/wall) and other properties. These cubes are grouped 2x2 at a time recursively into a "quad tree", which is used hold bigger cubes which can be rendered faster. For those who have edited doom, this is very similar to having a lot of square sectors but at overlapping sizes. This is results in a map that can have no room over room (yet), and is pretty cubic, except for the odd slope/slant here and there. -

-

- The floor size of a single unit (single cube) is similar to about 16x16 units in games such as doom & quake, so a staircase step is usually 1 unit, a wall 8 units high etc. -

-

- Cube renders this world by first determining which cubes are visible using a "dynamic occlusion culling" algorithm and frustrum culling. You can see the effect of this when you switch to edit mode (E), and then fly out above a map: you'll see parts of the map dropping away as you move. The remaining cubes are then rendered in their most efficient size (i.e. cube will render a mixture of 1x1 2x2 4x4 etc. size cubes, depending on wether they have the same properties: height, texturing etc.). -

-

- If you are on a fast machine, or you are playing a simple/small map, cube will simply render all of these visible cubes (this is indicated by LOD at its maximum of 250 on the hud). Cube can however make complex maps run fast even on slower computers by a technique called LOD: this will render cubes that are further away using bigger approximations (2x2 and up), even the properties of the constituent cubes don't match exactly. This reduces the amount of polys to be rendered tremendously, and thus allows even slow machines to have a consistent frame rate (cube will adapt the LOD figure every frame to aim for the fps you specify). The downside is of course that if the approximations are visible closeup, this can lead to ugly graphical glitches (this is called "popup" because it changes as you move). So in the end the choice is up to you: good fps or constant visual quality (most engines only cater for the latter). -

- -
- - -
- - - diff --git a/docs/cubedoc.css b/docs/cubedoc.css new file mode 100644 index 00000000..3e85a1d4 --- /dev/null +++ b/docs/cubedoc.css @@ -0,0 +1,167 @@ +/* (C) Adrian Henke 2007 - ZLIB License */ + +@import url(ac.css); + + +/* +html +{ + background-color: #343434; /* blame firefox' buggy xslt support +} + +body +{ + 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; +} + +*/ + +/* code */ + +div.code +{ + font-family: Courier New, Sans-Serif; + margin: 1em 0 1em 0; + padding: 0 0 0 1em; +} + +span.code +{ + font-family: Courier New, 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; +} \ No newline at end of file diff --git a/docs/cubedoc2xhtml.xslt b/docs/cubedoc2xhtml.xslt new file mode 100644 index 00000000..6f52aa59 --- /dev/null +++ b/docs/cubedoc2xhtml.xslt @@ -0,0 +1,39 @@ + + + + + + + + + + + + AssaultCube Readme + + + + + +
+
+ v0.93 +
+
+

+ AssaultCube README +

+
+
+ +
+ +
+ + +
+ +
+ diff --git a/docs/cuberef.css b/docs/cuberef.css index 6f950927..e1c7dbd2 100644 --- a/docs/cuberef.css +++ b/docs/cuberef.css @@ -69,9 +69,10 @@ div#cuberef div#version width: 720px; font-family: Courier New, Sans-Serif; - font-size: 50px; + font-size: 55px; font-weight: bold; text-align: right; + color: #555555; } /* title */ @@ -176,6 +177,12 @@ div#cuberef div.section div.identifier div.displayname margin: 1em 0 1em -20px; } +div#cuberef div.section div.identifier div.displayname a +{ + color: Black; + text-decoration: none; +} + /* command arguments */ div#cuberef div.section div.identifier div.argumentDescriptions diff --git a/docs/cuberef.txt b/docs/cuberef.txt new file mode 100644 index 00000000..3ff13834 --- /dev/null +++ b/docs/cuberef.txt @@ -0,0 +1,38 @@ + CubeRef Recommendations + + General + * see the xml schemas for details on the elements + * do not use any xml editor that rapes the formatting + * do not write tutorial-like content, this is a reference. therefore focus on the + technical description of identifiers as a single unit + * use a CDATA section for content that requires special characters + + Sections + * a section represents a group of identifiers + * chose sections based on the usage areas of identifiers + + Identifiers + * an identifier represents a command, variable or an alias that is available through cubescript + * identifiers must be unique across sections + * custom aliases located in default.cfg must not be documented + + Description + * provide a short an concise description of what the identifier does or represents, omit details + + Arguments + * use a single character token if possible + * keep the argument description simple, write a remark for details + * write restricted integer values in the way of 0..3 (0 to 3) and 1..* (0 to 'infinite') + * if no restrictions apply to values, specify the pseudo data type + * if the meaning of the arguments depends on other arguments, create multiple identifiers + with the name containing the depending argument. example: 'newent type v1 v2 v3 v4' depends + on the type, therefore it's split to 'newent light', 'newent ammo', etc. + + Remarks + * describe details and special behavior + * give _short_ examples if needed + + References + * refer to other identifiers that are _directly_ related + * refer to _official_ online sources like the wiki + * name other (offline) sources without url or identifier \ No newline at end of file diff --git a/docs/cuberef.xsd b/docs/cuberef.xsd index bcd56aeb..81de7f9e 100644 --- a/docs/cuberef.xsd +++ b/docs/cuberef.xsd @@ -1,92 +1,195 @@  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/transformcubescript.xslt b/docs/cuberef2cubescript.xslt similarity index 98% rename from docs/transformcubescript.xslt rename to docs/cuberef2cubescript.xslt index 9d5e0ce9..d30cf61e 100644 --- a/docs/transformcubescript.xslt +++ b/docs/cuberef2cubescript.xslt @@ -10,7 +10,7 @@ - // auto generated script to make the command reference readable for ActionCube + // auto generated script to make the command reference readable for AssaultCube diff --git a/docs/transformxhtml.xslt b/docs/cuberef2xhtml.xslt similarity index 82% rename from docs/transformxhtml.xslt rename to docs/cuberef2xhtml.xslt index 9aa48d19..fa0d681e 100644 --- a/docs/transformxhtml.xslt +++ b/docs/cuberef2xhtml.xslt @@ -1,67 +1,71 @@ - + - + - - - - - - <xsl:value-of select="@name"/> - - - - - - -
- -
- -
+ + + + #identifier_ + + + + + - -
-

- -

-
+ + + + + <xsl:value-of select="@name"/> + + + + -
+ +
- -
- - - -
+ +
+ +
+ + +
+

+ +

+
+ +
+ + +
+ + + +
@@ -122,7 +126,8 @@
- + + diff --git a/docs/docs.css b/docs/docs.css index a5c9bf5e..4189da89 100644 --- a/docs/docs.css +++ b/docs/docs.css @@ -1,8 +1,12 @@ /* (C) Adrian Henke 2007 - ZLIB License */ +html +{ + background-color: #343434; /* blame firefox' buggy xslt support */ +} + body { - background-color: #343434; font-family: Verdana, Sans-Serif; margin: 0px; padding: 10px 0 10px 0; diff --git a/docs/editref.html b/docs/editref.html deleted file mode 100644 index e4f0c574..00000000 --- a/docs/editref.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - ActionCube README - - - - - -
- - -
- -

Map Editing Reference

- -
- edittoggle -
- - switches between map edit mode and normal (default key = e). In map edit mode you can select bits of the map by clicking or dragging your crosshair on the floor or ceiling (using the "attack" command, normally MOUSE1), then use the commands below to modify the selection. While in edit mode, physics & collision don't apply (noclip), and key repeat is ON. Note that if you fly outside the map, cube still renders the world as if you were standing on the floor directly below the camera. - -
- edittex T D -
- - Changes the texture on current selection by browsing through a list of textures directly shown on the cubes. T is an integer denoting the type (floor = 0, lower or wall = 1, ceiling = 2, upper wall = 3), D is the direction you want to cycle the textures in (1 = forwards, -1 = backwards). Default keys are the six keys above the cursor keys, which each 2 of them cycle one type (and numpad 7/4 for upper). - - The way this works is slightly strange at first, but allows for very fast texture assignment. All textures are in 3 individual lists for each type (both wall kinds treated the same), and each time a texture is used, it is moved to the top of the list. So after a bit of editing, all your most frequently used textures will come first when pressing these keys, and the most recently used texture is set immediately when you press the forward key for the type. These lists are saved with the map. make a selection (including wall bits) and press these keys to get a feel for what they do. - -
- editheight T D -
- - T is the type as above (floors & ceilings only), and D is the delta value to move it in. Default keys are [ and ] for floor level, and o/p for ceiling. - -
- solid B -
- - makes the current selection all solid (i.e. wall) if B is true (non-zero), or all non-solid if it is false (0). This operation retains floor/ceiling heights/textures while swapping between the two. Default keys f and g respectively. - -
- equalize T -
- - levels the floor/ceiling of the selection (T as above). default keys , and . - -
- heightfield T -
- - marks the current selection as a heightfield, with T being floor or ceiling, as above. A surface marked as heightfield will use the vdelta values (see below) of its 4 corners to create a sloped surface. To mark a heightfield as normal again (ignoring vdelta values, set or not) use "solid 0". Default keys are h (floor) and i (ceiling). - - Heightfields should be made the exact size that is needed, not more not less. The most important reason for this is that cube automatically generates "caps" (side-faces for heightfields) only on the borders of the heighfield. This also means if you have 2 independant heightfields accidentally touch eachother, you will not get correct caps. Also, a heighfield is slightly slower to render than a non-heighfield floor or ceiling. Last but not least, a heightfield should have all the same baseheight (i.e. the height determined by a normal editheight operation) to get correct results. - -
- vdelta N -
- - changes the vdelta value of the current selection by N. Note that unlike all other editing functions, this function doesn't affect a cube, but its top-left vertex (market by the dot in the editing cursor). So to edit a N * M heightfield, you will likely have to edit the vdelta of (N+1) * (M+1) cubes, i.e. you have to select 1 row and 1 column more in the opposite direction of the red dot to affect all the vertices of a heightfield of a given size (try it, it makes sense :) - - A floor delta offsets vertices to beneath the level set by editheight (and a ceil delta to above). Delta offsets have a precision of a quarter of a unit, however you should use non-unitsize vertices only to touch other such vertices. Default keys are 8 and 9 to decrease/increase the vdelta. - -
- corner -
- - # makes the current selection into a "corner". Currently there is only one type of corner (a 45 degree one), only works on a single unit (cube) at a time. It can be positioned: next to 2 solid walls - # in the middle of 2 higher floorlevels and 2 lower ones forming a diagonal (and similar with ceiling) - - In both cases, the corner will orient itself automatically depending on its neighbours, behaviour with other configurations than the 2 above is unspecified. Since the latter configuration generates possibly 2 floor and 2 ceiling levels, up to 4 textures are used: for example for the 2 floors the higher one will of the cube itself, and the lower one of a neighbouring low cube. Default key = k you can make bigger corners at once by pressing "corner" on grid aligned 2x2/4x4/8x8 selections, with equal size solid blocks next to them. - -
- undo -
- - multi-level undo of any of the changes caused by the above operations (default key = u). - -
- undomegs N -
- - sets the number of megabytes used for the undo buffer (default 1). undo's work for any size areas, so the amount of undo steps per megabyte is more for small areas than for big ones (a megabyte fits 280 undo steps on a 16x16 area, but only 4 steps on a 128x128 area). - -
- copy - - paste -
- - copy copies the current selection into a buffer. to paste it back requires a same size selection at the destination location. If it is not the same size the selection will be resized automatically prior to the paste operation (with the red dot as anchor), which is easier for large selections. (default keys are c and v respectively). - -
- replace -
- - repeats your last texture edit thruout the map. The way it works is intuitive: simply edit any texture anywhere, then using "replace" will replace all textures thruout the map in the same way (taking into account wether it was a floor/wall/ceil/upper too). if the there was more than one "old" texture in your selection, the one nearest to the red dot is used. This operation can't be undone. - -
- newent type value1 value2 value3 value4 -
- -

- adds a new entity where (x,y) is determined by the current selection (the red dot corner) and z by the camera height, of said type. Type is a string giving the type of entity, such as "light", and may optionally take values (depending on the entity): -

- -
    -
  • -
    - "light" radius brightness
    - "light" radius r g b -
    - - radius in units (1..32), optionally brightness (1..255) for a white light, or coloured light (each component 1..255). Default key l creates a new light (cylindrical) of radius 16, brightness 255 (white). -
  • - - -
  • -
    - "playerstart" N -
    - - Spawn spot, yaw is taken from the current camera yaw. N can be 0, 1 or 100 for a CLA, RVSF or FFA spawn. -
  • -
  • -
    - "shells", "bullets", "rockets", "riflerounds", "health",
    - "healthboost", "greenarmour", "yellowarmour", "quaddamage" -
    - - A variety of pickup-able items, see here. -
  • -
  • -
    - "teleport" N
    - "teledest" N -
    - - creates a teleport connection, teleports are linked to a teledest with the same N (of which there should be exactly one). N can be 0..255. The teledest uses the current camera yaw. -
  • -
  • -
    - "mapmodel" N Z T -
    - - A map model, i.e. an object rendered as md2 which you collide against but has no behaviour/movement. N determines which mapmodel you want, which is defined by the "mapmodel" command, see below. yaw of the model is taken from the current camera yaw (snapped to 15 degree increments). Z determines extra elevation above the default (usually the ground). T is the map texture to use (see data/default_map_settings.cfg for the number), if left as 0 then the skin.jpg in the model directory is used (if present). Mapmodels are more expensive than normal map geometry, do not use insane amounts of them to replace normal geometry. -
  • -
  • -
    - "monster" N -
    - - A monster, currently N = 0..4 (see gameplay docs). Monster entities will be spawned when in classic single player mode, and will attack you when you come into view. yaw is taken from the current camera yaw. -
  • -
  • -
    - "trigger" N T O -
    - -

    - A trigger of type T affecting all cubes with tag N when triggered in game (see "edittag" on how to set tags on cubes). Triggers are rendered as a carrot which, when "eaten", trigger an event (only once). The following trigger types are available: -

    - -
      -
    • - 0: On being triggered, sets all target cubes to SPACE. This has the effect of instantly opening doors or other geometry. You edit these "doors" as SPACE, i.e. you determine what the "door" looks like when opened, they are then set to SOLID automatically when playing (map start / edit toggle). Current "doors" open instantly. "rumble" sound alerts the player something has opened. -
    • -
    • - 1: invisible: same as 0 but without the carrot. since the trigger radius is fairly small, be sure to place them in tiny hallways and other areas you are sure the player will pass through. -
    • -
    • - 2: end of map marker. ends the map and triggers the intermission. carrot spins wildly. -
    • -
    • - 3: same as 1, but makes no rumble sound. -
    • -
    • - 4: same as 0, but with switch model instead of carrot (O is orientation, 0..3) -
    • -
    • - 5: same as 0, but with lever model instead of carrot (O is orientation, 0..3) -
    • -
    -
  • - -
  • -
    - "ctf-flag" N -
    - - Adds a CTF flag. N can be 0 or 1 for a CLA resp. RVSF flag. -
  • - -
  • -
    - ladder -
    - -

    - Adds a ladder entity. -

    -
  • - -
  • -

    - Scripting: each trigger automatically executes the alias "level_trigger_N" where N is the trigger number. This means you can add any scripting you can do through the available commands, by simply putting aliases of this kind in the level .cfg file. For example, to print a message when the user hits trigger 1: -

    -
  • - -
  • -

    - alias level_trigger_1 "echo A door opened nearby" -

    -
  • - - -
- - Entities are shown in editmode by blue sparklies, and the closest one is indicated on the HUD. - -
- delent -
- - deletes the entity closest to the player (default key x) - -
- entproperty P A -
- - changes property P (0..3) of the closest entity by amount A. For example "entproperty 0 2" when executed near a lightsource would increase its radius by 2. - -
- clearents type -
- - deletes all entities of said type. - -
- recalc -
- - recomputes all there is to recompute about a map, currently only lighting. Default key = r - -
- map name -
- - loads up map "name" in the gamemode set previously by "mode". A map given as "blah" refers to "packages/base/blah.cgz", "mypackage/blah" refers to "packages/mypackage/blah.cgz". The menu has a set of maps that can be loaded. See also map in the gameplay docs. - - At every map load, "data/default_map_settings.cfg" is loaded which sets up all texture definitions etc. Everything defined in there can be overridden per package or per map by creating a "package.cfg" or "mapname.cfg" which contains whatever you want to do differently from the default. It can also set up triggers scripts per map etc. - - When the map finishes it will load the next map when one is defined, otherwise reloads the current map. You can define what map follows a particular map by making an alias like (in the map script): alias nextmap_blah1 blah2 (loads "blah2" after "blah1"). - -
- savemap name -
- - saves the current map, using the same naming scheme as "map". makes a versioned backup (mapname_N.BAK) if a map by that name already exists, so you can never lose a map. If you leave out the "name" argument, it is saved under the current map name. - - where you store a map depends on the complexity of what you are creating: if its a single map (maybe with its own .cfg) then the "base" package is the best place. If its multiple maps or a map with new media (textures etc.) its better to store it in its own package (a directory under "packages"), which makes distributing it less messy. - -
- newmap size -
- - creates a new map of 2^size cubes. 6 is small, 7 medium, 8 large. You can go up to 12 but theres not a lot of point in that :) - -
- mapenlarge -
- - if you accidentally made your map too small, this command will make it 1 power of two bigger. So if you created a 6 size map (64x64 units) it will become a 7 map (128x128), with your old map in the middle (from 32-96) and the new areas solid. - -
- mapmsg "Title by Author" -
- - sets the map msg, which will be displayed when the map loads. Either use the above format, or simply "by Author" if the map has no particular title (always displayed after the map load msg). - -
- waterlevel H -
- - sets the global water level in your map to H (an empty map has levels 0-16), which will render every cube that has a lower floor than H with a nice wavy water alpha texture, and applies water physics to any entity located below it. Performance notes: water is rendered for a whole square encapsulating all visible water areas in the map (try flying above the map in edit mode to see how). So the most efficient water is a single body of water, or multiple water areas that are mostly not visible from eachother. Players can influence how accurate the water is rendered using the "watersubdiv" command (config). - -
- fullbright B -
- - sets all light values to fullbright (1 = on, 0 = off), so you don't need to edit the map in the dark. Will be reset when you issue a recalc. Only works in edit mode. - -
- showmip -
- - Toggles between showing what parts of the scenery are rendered using what size cubes, and outputs some stats too. This can give mappers hints as to what architecture to align / textures to change etc. - -
- toggleocull -
- - turns occlusion culling on & off. the reason you may want to turn it off is to get an overview of your map from above, without having all occluded bits stripped out. - -
- texturereset -
- - sets the texture slot to 0 for the subsequent "texture" commands - -
- texture subnum filename -
- - binds the texture indicated in filename to the current texture slot, then increments the slot number. This is for use in texture.cfg files only. subnum allows secondary textures to be specified for a single texture slot, for use in shaders and other features (unused for now, should be set to 0 to indicate primary texture). - -
- slope xdelta ydelta -
- - makes a slope out of the current selection (make it a heighfield first). xdelta and ydelta are the steps that specify the slope with the red vertex as left-top, i.e. "slope 1 2" will make a slope that increases just 1 step from left to right, and is slightly steeper from top to bottom. "slope -6 0" decreases steeply from left to right, and does not slope at all from top to bottom. Note that like the vdelta command, an increasing vdelta goes further away from the player, regardless of floor or ceiling. - -
- arch sidedelta -
- - makes an arch out of the current selection (first make it a heightfield of some sort). Will make the arch in the long direction, i.e when you have 6x2 cubes selected, the arch will span 7 vertices. optionally, sidedelta specifies the delta to add to the outer rows of vertices in the other direction, i.e. give the impression of an arch that bends 2 ways (try "arch 2" on an selection of atleast 2 thick to see the effect). Not all arch sizes are necessarily available, see data/prefabs.cfg. - -
- archvertex span vertex delta -
- - defines a vertex delta for a specific arch span prefab, used by the "arch" command. See data/prefabs.cfg for an example on usage. - -
- perlin scale seed cubesize -
- - generates a perlin noise landscape in the current selection. scale determines the frequency of the features, default = 10. seed sets the random seed, keep this the same if you want to create multiple perlin areas which fit with eachother, or use different numbers if you want alternative random generations. cubesize says how many cubes to generate a surface for at once, not used for now. - -
- select x y xs ys -
- - selects the given area, as if dragged with the mouse. Useful for making complex geometry-generating scripts. The current dimensions of the selection (either created by the user or this command) are in the variables selx, sely, selxs and selys and can also be read/modified. Coordinates are as follows: after a "newmap 6" the top-left corner (the one where the red dot points) are (8,8), the opposite corner is (56,56) (or (120,120) on a "newmap 7" etc.). - -
- edittag N -
- - sets the tag value (1..255) for the current selection (0 means no tag). Tags are used to determine what cubes to modify when a certain tag is triggered (see "newent trigger"). If a cube has a tag associated with it, gridlines show up in red. - -
- trigger N T -
- - triggers trigger N of type T, as if the player had picked up the equivalent "trigger" entity (see above). - -
- music name -
- - plays song "name" (with "packages" as base dir). This command is best used from map cfg files or triggers. - -
- N = registersound name -
- - registers sound "name" with cube (see for example data/sounds.cfg). This command returns the sound number N, which is assigned from 0 onwards, and which can be used with "sound" command below. if the sound was already registered, its existing index is returned. registersound does not actually load the sound, this is done on first play. - -
- sound N -
- - plays sound N, see data/sounds.cfg for default sounds, and use registersound to register your own. for example, sound 0 and sound (registersound "aard/jump") both play the standard jump sound. - -
- mapmodelreset -
- - resets the mapmodel slots/indices to 0. Each subsequent mapmodel command increases it again. see default_map_settings.cfg for an example - -
- mapmodel R H Z S N -
- - registers a mapmodel that can be placed in maps using newent mapmodel (see newent). N is the name, R is the square radius, H the height, Z the initial Z-offset above ground, and S the snap value in 16ths of a cube unit (0 meaning no snap). All of these values are used for collision as well as rendering. Specifying a snap can be useful for architectural mapmodels, as the md2 format doesn't provide exact vertex coordinates. Example: mapmodel 4 2 4 2 this map model is 8x8x2 in size (x,y,z), by default hovers 4 units above ground, and has all coordinates snapped to the nearest even number. See data/models.cfg. - -
- scalelights RP IP -
- - Scales all lights in the map. Radius is scaled by perceptage RP and intensity by IP. Useful if you have a map which is too dark or bright but you want to keep the light entities where they are. - -
- - -
- - - diff --git a/docs/game.html b/docs/game.html deleted file mode 100644 index faede517..00000000 --- a/docs/game.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - 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 mercenaries, 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 backgrounds 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
GQuick nade throw
BWeapon menu
Left MousebuttonAttack
Right MousebuttonQuick nade throw / Scope when using the sniper
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 "grenades"
-
- -

- 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. It is your last resort when you ran out of ammo as well as your best friend - in humiliating snipers and campers. Frags done using this weapon count twice. (0) -

-
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. (1) -

-
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. (5) -

-
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. - Headshot frags count twice and do three times as much damage. (4) -

-
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. (3) -

-
shotgun - V-19 Combat Shotgun
-

- 7-round semi-automatic shotgun. This powerful weapon can shred your opponents to pieces - - if you´re close enough. (2) -

-
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. Frags done using this weapon count twice. (6) -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
weapondamageattackdelayRPSdmg/secreloadmagsizebasemax
Swiss Tech Combat Blade DR-8850500ms2100----
Mk-77 Semi-Automatic Pistol19170ms5.91121400ms83280
MTP-57 Assault Rifle24130ms7.71852000ms156080
Precision Tech AD-81 Sniper Rifle851500ms0.6561950ms52020
A-Ard 10 Submachine Gun1680ms12.52001650ms3060120
V-19 Combat Shotgun1051000ms11052400ms72828
SAL-T3 Grenade1501200ms0.8125--02
- -

- Every player spawns with three weapons. - - Knife and 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 weapon 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: -

-
    -
  • 30 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. - -
    -
  • - Team Deathmatch (0)
    - Two teams fight each other. The team that has the most frags at the end of the round will win. -
  • -
  • - Team Survivor (4)
    - Round based team combat. If you die, you will have to wait until the end of the round until you can spawn again. Once all members of a team are dead, the surviving team will be awarded a point and the next round will start. -
  • -
  • - Last Man Standing (3)
    - Round based combat, no teams. The surviving player will win the round and be awarded a point. -
  • -
  • - Deathmatch (2)
    - No teams, everyone for himself :P -
  • -
  • - Capture The Flag (5)
    - Steal the enemy team`s flag and bring it back to your base to score. Note, there is a special HUD for the ctf mode. -
  • -
  • - Pistol Frenzy (6)
    - Pistol-only deathmatch. -
  • -
  • - Last Swiss Standing (9)
    - Survive the battle with the help of your knife. -
  • -
  • - One Shot, One Kill (10)
    - Use your sniper rifle to survive. -
  • -
  • - Team One Shot, One Kill (11)
    - Fight the enemy team using the sniper rifle and the knife. -
  • -
- -

Bots

- -

- ActionCube comes with bots to offer singleplayer deathmatching. To start a botmatch, press ESC and navigate to Singleplayer. - There you can choose the mode, skill, number of bots and the map to play on. Please keep in mind that ActionCube`s main approach is multiplayer gaming, - the bots lack certain features. -

- -
- - -
- - - diff --git a/docs/game.xml b/docs/game.xml new file mode 100644 index 00000000..56ac5dbb --- /dev/null +++ b/docs/game.xml @@ -0,0 +1,366 @@ + + + + + + + +

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 mercenaries, 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 backgrounds 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
GQuick nade throw
BWeapon menu
Left MousebuttonAttack
Right MousebuttonQuick nade throw / Scope when using the sniper
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 "grenades"
+
+ +

+ 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. It is your last resort when you ran out of ammo as well as your best friend + in humiliating snipers and campers. Frags done using this weapon count twice. (0) +

+
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. (1) +

+
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. (5) +

+
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. + Headshot frags count twice and do three times as much damage. (4) +

+
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. (3) +

+
shotgun + V-19 Combat Shotgun
+

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

+
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. Frags done using this weapon count twice. (6) +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
weapondamageattackdelayRPSdmg/secreloadmagsizebasemax
Swiss Tech Combat Blade DR-8850500ms2100----
Mk-77 Semi-Automatic Pistol19170ms5.91121400ms83280
MTP-57 Assault Rifle24130ms7.71852000ms156080
Precision Tech AD-81 Sniper Rifle851500ms0.6561950ms52020
A-Ard 10 Submachine Gun1680ms12.52001650ms3060120
V-19 Combat Shotgun1051000ms11052400ms72828
SAL-T3 Grenade1501200ms0.8125--02
+ +

+ Every player spawns with three weapons. + + Knife and 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 weapon 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: +

+
    +
  • 30 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

+ + AssaultCube offers seven different game modes. You can vote for one of them using the menu: Press ESC and navigate to Multiplayer ⇒ Vote. + +
    +
  • + Team Deathmatch (0)
    + Two teams fight each other. The team that has the most frags at the end of the round will win. +
  • +
  • + Team Survivor (4)
    + Round based team combat. If you die, you will have to wait until the end of the round until you can spawn again. Once all members of a team are dead, the surviving team will be awarded a point and the next round will start. +
  • +
  • + Last Man Standing (3)
    + Round based combat, no teams. The surviving player will win the round and be awarded a point. +
  • +
  • + Deathmatch (2)
    + No teams, everyone for himself :P +
  • +
  • + Capture The Flag (5)
    + Steal the enemy team`s flag and bring it back to your base to score. Note, there is a special HUD for the ctf mode. +
  • +
  • + Pistol Frenzy (6)
    + Pistol-only deathmatch. +
  • +
  • + Last Swiss Standing (9)
    + Survive the battle with the help of your knife. +
  • +
  • + One Shot, One Kill (10)
    + Use your sniper rifle to survive. +
  • +
  • + Team One Shot, One Kill (11)
    + Fight the enemy team using the sniper rifle and the knife. +
  • +
+ +

Bots

+ +

+ AssaultCube comes with bots to offer singleplayer deathmatching. To start a botmatch, press ESC and navigate to Singleplayer. + There you can choose the mode, skill, number of bots and the map to play on. Please keep in mind that AssaultCube`s main approach is multiplayer gaming, + the bots lack certain features. +

+ + diff --git a/docs/gamecommands.html b/docs/gamecommands.html index 7900efe0..0da58bbd 100644 --- a/docs/gamecommands.html +++ b/docs/gamecommands.html @@ -1,7 +1,7 @@  - ActionCube README + AssaultCube README diff --git a/docs/getstarted.html b/docs/getstarted.html deleted file mode 100644 index 64f44e43..00000000 --- a/docs/getstarted.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - ActionCube README - - - - - -
- - -
- -

Prerequisites

- -

System Requirements

- -

- If your Cube installation runs fine, ActionCube does too.
- Minimum specs: P-III 500 Mhz with gf1/radeon or better. -

- -

- Recommended gfx setting for low/medium machines: -

- -
    -
  • 800x600@16bpp
  • -
  • Antialiasing: OFF
  • -
  • Anisotropic Filtering:OFF
  • -
- -

- Linux users: Make sure you have libSDL 1.2, libSDL_image and libSDL_mixer installed. -

- -

Setting Resolution

- -

- The default resolution is 1024x768. If you need to change it, modify actioncube.bat accordingly, e.g.: -

-

- -w800 -h600 -

- -

- In linux, simply pass those parameters in the command line or add them to the actioncube.sh shell script. - Check the config section to see all available command-line options. -

- -

Running the game

- -

- Windows: Start the actioncube.bat -

- -

- Linux: cd to the main actioncube directory and execute actioncube.sh -

- -

Basics

- -

Interface

- -

- In game, press ESC to access the main menu. From there you can do all sorts 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 command into the console: -

- -
- crosshairsize 25 -
- -

- This will increase the size of your crosshair. Check the game commands section to see - all gameplay relevant commands you can use through CubeScript. -

- -

- Hint: Press F11 to get a bigger console history. -

- -

Saving Settings

- -

- There is the file defaults.cfg in the config directory. If you run ActionCube for the first time - it will execute this file. Once you quit ActionCube, the default settings and your changes on them will be - stored to config/saved.cfg. If you want to reset your settings to the default values just delete it. -

- -

- Edit the config/autoexec.cfg file and insert scripting commands you want to execute on every start of the game. -

- -

Setting Your Name

- -

- Open the console as described above and type the following command: -

- -
name yourname
- -

- where yourname is your desired name. -

- - -

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 P -
- -

- Where N is a valid IP or FQDN and P a password (optional). -

- -

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/getstarted.xml b/docs/getstarted.xml new file mode 100644 index 00000000..5595f5be --- /dev/null +++ b/docs/getstarted.xml @@ -0,0 +1,140 @@ + + + + + + + + +

+ Get Started +

+

+ System Requirements +

+

+ If your Cube installation runs fine, AssaultCube does too. + Minimum specs: P-III 500 Mhz with gf1/radeon or better. +

+

+ Recommended gfx setting for low/medium machines: +

+
    +
  • 800x600@16bpp
  • +
  • Antialiasing: OFF
  • +
  • Anisotropic Filtering:OFF
  • +
+

+ Linux users: Make sure you have libSDL 1.2, libSDL_image and libSDL_mixer + installed. +

+

+ Setting Resolution +

+

+ The default resolution is 1024x768. If you need to change it, modify AssaultCube.bat + accordingly, e.g.: +

+

+ -w800 -h600 +

+

+ In linux, simply pass those parameters in the command line or add them to the AssaultCube.sh + shell script. Check the startup section to + see all available command-line options. +

+

+ Running the game +

+

+ Windows: Start the AssaultCube.bat +

+

+ Linux: cd to the main AssaultCube directory and execute AssaultCube.sh +

+

+ Basics +

+

+ Interface +

+

+ In game, press ESC to access the main menu. From there you can do all sorts 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 command into the console: +

+
+ crosshairsize 25 +
+

+ This will increase the size of your crosshair. Check the + reference + to see all gameplay relevant commands you can use + through CubeScript. +

+

+ Hint: Press F11 to get a bigger console history. +

+

+ Saving Settings +

+

+ There is the file defaults.cfg in the config directory. If you run + AssaultCube for the first time it will execute this file. Once you quit AssaultCube, + the default settings and your changes on them will be stored to config/saved.cfg. + If you want to reset your settings to the default values just delete it. +

+

+ Edit the config/autoexec.cfg file and insert scripting commands you want + to execute on every start of the game. +

+

+ Setting Your Name +

+

+ Open the console as described above and type the following command: +

+
+ name yourname +
+

+ where yourname is your desired name. +

+

+ 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 P +
+

+ Where N is a valid IP or FQDN and P a password (optional). +

+

+ 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 deleted file mode 100644 index e207f051..00000000 --- a/docs/history.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - ActionCube - - - - - -
- - -
- -

History

- -

ActionCube v0.92

- -

17. January 07

- -
    -
  • new bot gamemode one shot, one kill
  • -
  • auto team
  • -
  • connecting players stay dead in arena modes
  • -
  • colored messages
  • -
  • public and private server mastermodes
  • -
  • tweaked weapon balance
  • -
  • sniper headshot kills instantly and shows some gibs
  • -
  • all gib frags count as two frags (knife, nade, sniper headshot)
  • -
  • ctf flag reset on teamkill
  • -
  • a big note on the teamkillers screen
  • -
  • quick nade throw (key G, MOUSE2)
  • -
  • better spawning
  • -
  • fixed skin menu
  • -
  • fixed flag disappear on disconnect
  • -
  • fixed shooting while editing
  • -
  • fixed invincible bots
  • -
  • fixed several memory bugs
  • -
- -

ActionCube v0.91

- -

12. November 06

- -

- Some of the features are backports from Sauerbraten. Thanks to eihrul. -

- -
    -
  • new game mode "one shot, one kill"
  • -
  • new map ac_desert2
  • -
  • netcode and new version of the enet library, consumes less bandwidth
  • -
  • weapon balance tweaked
  • -
  • config saving
  • -
  • support for md3 mapmodels
  • -
  • faster geometry rendering
  • -
  • faster ladder climbing
  • -
  • 3rd person death
  • -
  • advanced console
  • -
  • screenres command and fullscreen var
  • -
  • limit fps with maxfps
  • -
  • -z, -b, and -a command-line options
  • -
  • ctf flagpick bug fixed
  • -
  • gib crash fixed
  • -
  • flag count fixed
  • -
  • scores now save across disconnects
  • -
  • player death animation fixed
  • -
  • weapon hit absorbtion fixed
  • -
- - -

ActionCube v0.9

- -

- 4. November 06 - Release of the first public beta. Some quick infos: -

- -

- Artwork -

- -
    -
  • 55 new mapmodels
  • -
  • 4 high quality maps
  • -
  • 100% new texture set (new, not fully original ;)
  • -
  • 100% new content (original, apart from sounds, playermodel)
  • -
  • new guns: Knife, Pistol, Shotgun, Subgun, Assault Rifle, Sniper Rifle, Grenades
  • -
  • new items: Health, Ammobox , Kevlar, Clips, Grenades, Akimbo Powerup
  • -
  • new sounds
  • -
  • the well known sas quake2 model by Darren Pattenden
  • - -
- -

- Game/Engine -

- -
    -
  • gamemodes -
      -
    • Capture The Flag (pCube)
    • -
    • Team Deathmatch
    • -
    • Team Survivor
    • -
    • Last man Standing
    • -
    • Deathmatch
    • -
    • Pistol Frenzy
    • -
    • Last Swiss Standing
    • -
    -
  • -
  • two fixed teams with chooseable skins
  • -
  • server side maprotation (pCube)
  • -
  • md3 hudguns
  • -
  • vweap support for all weapons
  • -
  • weapon reloading
  • -
  • bullet flyby fx
  • -
  • weapon bob/sway
  • -
  • ladders
  • -
  • gib fx
  • -
  • new menu/hud gfx (model drawing)
  • -
  • simple kick/ban system
  • -
  • bot support (adaption of the cubebots)
  • -
- -

The day makkE came to town

- -
- **** BEGIN LOGGING AT Sun Aug 1 11:46:13 2004
- Aug 01 16:12:02 --> makkE (makkE@116-1-87.w193-250.abo.wanadoo.fr) has joined #actioncube
- Aug 01 16:12:18 <makkE> hi
- Aug 01 16:13:29 <driAn> hi -
- -

Project Launch

- -

- July 04 - Arghvark, driAn, Verbal_ and dtd started working on ActionCube. -

- -
- - -
- - - diff --git a/docs/mappers_readme.txt b/docs/mappers_readme.txt index d0bbf44d..ac55e180 100644 --- a/docs/mappers_readme.txt +++ b/docs/mappers_readme.txt @@ -1,4 +1,4 @@ -::ActionCube Mappers Readme:: +::AssaultCube Mappers Readme:: Before you start mapping, MAKE YOUR OWN .CFG ! The config/default_map_settings.cfg is only an example and might change with every release, @@ -8,11 +8,11 @@ Use the defaul_map_settings.cfg as base for your own .cfg, comment'texture-lines Choose which skymap you d'like, etc. Note the comments on particular mapmodel´s usage -.:Maps for the ActionCube Project: +.:Maps for the AssaultCube Project: If you want send us the maps you will make, you need to read the following lines. These rules/definitions are necessary because the maps that come with an -ActionCube release must be of high-quality. +AssaultCube release must be of high-quality. - AC maps should look a bit grim, dusky . diff --git a/docs/misc.html b/docs/misc.html deleted file mode 100644 index 93c26d02..00000000 --- a/docs/misc.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - ActionCube: Misc - - - - - -
- - -
- -

Misc

- -

Crosshair

- -

- You can change your crosshair using the menu Team/Player Setup ⇒ Change Crosshair. -

- -

- To change the size of your crosshair, type this into the console: -

- -
- crosshairsize 15 -
- -

- Where 15 is your desired crosshair size. -

- - -

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 98b0b5ea..b2db1e00 100644 --- a/docs/package_copyrights.txt +++ b/docs/package_copyrights.txt @@ -1,4 +1,4 @@ -This file holds the copyright information for all packages/artwork included in ActionCube (UNLESS OTHERWISE NOTED). Please respect the authors´ reserved rights and permissions. +This file holds the copyright information for all packages/artwork included in AssaultCube (UNLESS OTHERWISE NOTED). Please respect the authors´ reserved rights and permissions. --------------MAPS------------------- @@ -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 AssaultCube, all rights reserved. cube.dietmarpier.de diff --git a/docs/reference.xml b/docs/reference.xml index 22adc5c2..fd3e62c9 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -1,18 +1,18 @@  - + - - + + This reference describes the commands and variables available in AssaultCube. - +
diff --git a/docs/server.html b/docs/server.xml similarity index 68% rename from docs/server.html rename to docs/server.xml index 2e47fef9..ae6fc8f0 100644 --- a/docs/server.html +++ b/docs/server.xml @@ -1,185 +1,173 @@ - - - - ActionCube README - - - - + + + -
- - -
- -

+ + + +

Setting up a Server -

- -

The ActionCube Server

- + + +

The AssaultCube Server

+

Dedicated servers run in the shell only (no graphics), with increased priority yet use very little cpu time and memory, so you can run one in the background, or at the same time with a client if you want to host a game. Server port is - fixed at 28763, with 28764 being used for the server info requests (both UDP). See the Get Started Guide - to find out how to join a server. + fixed at 28763, with 28764 being used for the server info requests (both UDP). + See the Get Started Guide to find out how to join a server.

- -

Main Configuration

- + +

Main Configuration

+

- The ActionCube server is mainly configured using command line options set in the server script actioncube_server.bat on windows or + The AssaultCube server is mainly configured using command line options set in the server script actioncube_server.bat on windows or actioncube_server.sh on linux.

- +
bin_win32\ac_server.exe -c8 -n"My AC Server"
- +

- Possible command line options can be obtained from the configuration section of this readme. + Possible command line options can be obtained from the startup section of this documentation. Run the script to start the server.

- -

Maprotation

- + +

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
+    
+    // server side maprotations
+    // WARNING: You can NOT use CubeScript in there
+    // use the following scheme:
+    // map:mode:time:allowVote
 
-// ctf
-ac_mines:5:10:1
-ac_depot:5:10:1
-
+ // 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.

- -

Administration

- -

Cheating

+ +

Administration

+ +

Cheating

Cheating is a problem that can't be solved entirely. - ActionCube is opensource, so everyone that knows how to compile it can easily modify the source to do whatever he wants, + AssaultCube is opensource, so everyone that knows how to compile it can easily modify the source to do whatever he wants, thats the problem of opensource games. The fact that the whole game logic is client-side, to save a lot bandwith, makes it even easier to cheat. There is no way to avoid this abuse.

- -

Master Mode

- + +

Master Mode

+

- ActionCube adapts the useful feature called master mode known from the Cube 2 games. It's implemented in a slightly different way though. + AssaultCube adapts the useful feature called master mode known from the Cube 2 games. It's implemented in a slightly different way though. Servers operate in a so called master mode which allows people to easily and painlessly have games with people they know, without being disturbed by cheaters. The way it works is very simple: the first person to enter a server and use the setmaster command becomes the master of that server. The master of a server can force map changes, set a different master mode and perform other administrative actions normal players can't.

- +
setmaster B P
- +

where is B is 1 to claim master or 0 to give up master. P is an optional password that can be supplied to become master even if there is already a master on the server. The owner of a server can configure this password and use it as tool to remove the current master and become master himself.

- +

The master can change the master mode of the server using the mastermode command:

- +
mastermode N
- +

sets the master mode to N. Possible master modes are:

- +
  • 0 (open) - Anyone can enter the server. This is the default mode. It is good for games with random people, if no cheaters appear to be around.
  • 1 (private) - Noone can join the server anymore. Good for games with friends when cheaters are around, cheaters wont even connect, so wont have the chance to try and screw things up.
- - -

Kick and Ban

- + + +

Kick and Ban

+

Once you claimed master, you can kick and ban people from the server. Open the scoreboard (key: TAB) to look up the client number (cn) of the player you want to kick or ban.

- +
kick N
- +

kicks the player with the client number N from the server.

- +
ban N
- +

kicks the player with the client number N from the server and refuses any connection attempts from his IP for the next 20 minutes.

- +
rembans
- +

This removes all active bans.

- -

Auto Team

- + +

Auto Team

+

The current master can enable the auto-team option for the server. If enabled, newly connected clients will be forced to the smaller team and switching to the bigger or equal sized team won't be possible anymore. A team shuffle is performed every time the game mode changes from FFA to a team mode and when the auto-team option is initally enabled.

- +
autoteam N
- +

where N is 1 to enable and 0 to disable the auto-team option.

- -

Master Menu

- + +

Master Menu

+

Some administrative actions can be done using the GUI. Use this command to bring up the master menu:

- -
- mastermenu -
- -
- - -
- +
+ mastermenu +
+ +