Skip to content

Commit 01c70da

Browse files
author
Red Eclipse
committed
Build docs:159 from 70bbd87b3bfd8a20244096ace8aa06ca0b78c60c
1 parent 6634d57 commit 01c70da

33 files changed

+1420
-194
lines changed

docs/Editing-Reference.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/FAQ.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Red Eclipse is a [Free](http://www.gnu.org/philosophy/free-sw.html) and [Open So
4242

4343
## What are my rights regarding game servers?
4444

45-
- Anyone may run up to three (3) servers, and can be listed on the Red Eclipse Master Server, *however, only if they are in compliance with the guidelines, rules and policies outlined in the [Multiplayer Guidelines](Multiplayer-Guidelines)*. You can request a "trusted" (more servers) and/or "statistics" (contributes to stats) server from the Red Eclipse team.
46-
- Players must also abide by a set of guidelines as well, and are advised to view the **latter half** of the [Multiplayer Guidelines](Multiplayer-Guidelines).
45+
- Anyone may run up to three (3) servers, and can be listed on the Red Eclipse Master Server, *however, only if they are in compliance with the guidelines, rules and policies outlined in the ~~[Multiplayer Guidelines](Multiplayer-Guidelines)~~*. You can request a "trusted" (more servers) and/or "statistics" (contributes to stats) server from the Red Eclipse team.
46+
- Players must also abide by a set of guidelines as well, and are advised to view the **latter half** of the ~~[Multiplayer Guidelines](Multiplayer-Guidelines)~~.
4747
- Any player or server found to not be in compliance with these guidelines are susceptible to denial of access to the Red Eclipse Master Server either temporarily or indefinitely.
4848

4949
## Where else can I get help or discuss the game?
@@ -95,11 +95,11 @@ On Windows, when Red Eclipse detects the renderer as 'GDI Generic' it will repor
9595

9696
## Can I contribute to the game?
9797

98-
Development of Red Eclipse is open and community driven. Contributions can be maps created with the in-game ~~[editor](Editing-Guide)~~, art assets like models, config ~~[scripts](Cubescript-Guide)~~ like game menus, or modifications of the [source code](https://github.com/redeclipse/base/tree/master/src). For further information, please read our [contribution guidelines](Contributing).
98+
Development of Red Eclipse is open and community driven. Contributions can be maps created with the in-game ~~[editor](Editing-Basics)~~, art assets like models, or modifications of the [source code](https://github.com/redeclipse/base/tree/master/src). For further information, please read our [contribution guidelines](Contributing).
9999

100100
## I found a cheater, what can I do?
101101

102-
If you think someone cheats or violates the [Multiplayer Guidelines](Multiplayer-Guidelines) in some other way, you can open a issue in the [discussion area](/discuss). Be sure to attach a ~~[demo](Demo-Guide)~~ record of the game, so the problem can be investigated. Convictable cheaters will be sanctioned accordingly.
102+
If you think someone cheats or violates the ~~[Multiplayer Guidelines](Multiplayer-Guidelines)~~ in some other way, you can open a issue in the [discussion area](/discuss). Be sure to attach a ~~[demo](Demo-Guide)~~ record of the game, so the problem can be investigated. Convictable cheaters will be sanctioned accordingly.
103103

104104
## How can i change the chat colour?
105105

@@ -109,19 +109,19 @@ Only use bright colours with good contrast. A value of -1 will take your profile
109109

110110
## What is the game objective?
111111

112-
This depends on the current [mode and mutators](Modes-and-Mutators) of the game, which you can look up any time in the help menu (default key: **F1**). Click the large icons in the help menu to learn more about the rules of the current game. These help menus provide detailed information and tips, of which most can also be read on the wiki. There is also a [guide](Gameplay-Guide) for beginners.
112+
This depends on the current ~~[mode and mutators](Modes-and-Mutators)~~ of the game, which you can look up any time in the help menu (default key: **F1**). Click the large icons in the help menu to learn more about the rules of the current game. These help menus provide detailed information and tips, of which most can also be read on the wiki. There is also a ~~[guide](Gameplay-Guide)~~ for beginners.
113113

114114
## Why is my player score negative?
115115

116-
Be careful not to shoot your team mates, especially when using explosive weapons. Each team kill subtracts six points. Team kills on [flag carriers](Capture-the-Flag), [bombers](Bomber-ball) or ~~[defenders](Defend-and-Control)~~ even double this penalty. For details, see [Deathmatch Scoring](Deathmatch#scoring).
116+
Be careful not to shoot your team mates, especially when using explosive weapons. Each team kill subtracts six points. Team kills on ~~[flag carriers](Capture-the-Flag)~~ or ~~[bombers](Bomber-ball)~~ even double this penalty. For details, see [Deathmatch Scoring](Deathmatch#scoring).
117117

118118
## dm, pzap, gg - what did they just say?
119119

120120
For frequently used abbreviations and player slang, see [glossary](Glossary).
121121

122122
## What are those symbols near player names?
123123

124-
These are the [privileges](Privileges) or ranks of registered players. You can request your own player account [here](/apply).
124+
These are the ~~[privileges](Privileges)~~ or ranks of registered players. You can request your own player account [here](/apply).
125125

126126
## Why is there a timer when I get killed?
127127

@@ -133,11 +133,15 @@ It is easy to hit someone with a shotgun, but the weapon is really only effectiv
133133

134134
## How did they take away their own flag?
135135

136-
In [capture](Capture-the-Flag) games, you can press **F** (per default) to pick up the flag in your own base, so the enemy cannot reach it that easily. The same button can also be used to drop a flag you carry, be it yours or the enemy's.
136+
In ~~[capture](Capture-the-Flag)~~ games, you can press **F** (per default) to pick up the flag in your own base, so the enemy cannot reach it that easily. The same button can also be used to drop a flag you carry, be it yours or the enemy's.
137137

138-
## Why are there no ammo and health pickups?
138+
## Why are there no health pickups?
139139

140-
In Red Eclipse, players have an unlimited supply of weapon reloads, health regeneration and ~~[impulse](Impulse-Guide)~~ energy. Therefore, map control is less important, and everyone can focus on the real fun: Capturing that flag, grabbing that bomber ball… or just fragging!
140+
In Red Eclipse the player regenerates health and ~~[impulse](Parkour-Guide)~~ energy. Therefore, map control is less important, and everyone can focus on the real fun: Capturing that flag, grabbing that bomber ball… or just fragging!
141+
142+
## Why am I taking damage when no one is near me?
143+
144+
Your are under the effect of the a negative ~~[status effect](Status-Effects)~~.
141145

142146
## A green beeping thing obscured my vision - what the heck?
143147

docs/Glossary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The following list explains some commonly used terms and acronyms.
1414
| term | Description |
1515
|--------|-------------|
1616
| afk | away from keyboard. When spectators go AFK, they can and should alter their /name accordingly. Going AFK on a nearly full server can result in a kick. |
17-
| auth | authentication, a key for registered players to identify. Often used as synonym for player accounts or [privileges](Privileges). |
17+
| auth | authentication, a key for registered players to identify. Often used as synonym for player accounts or ~~[privileges](Privileges)~~. |
1818
| bb | bomber-ball, a game mode. Or bye bye. |
1919
| bot | usually refers to an A.I. controlled player. Not to confuse with aim-bot, a client side modification that is considered cheating according to the Multiplayer Guidelines. |
2020
| cc | creative-commons license, typically used for licensing of contributions. |
@@ -30,12 +30,12 @@ The following list explains some commonly used terms and acronyms.
3030
| gaud | the official unit for gaudiness. 100° C is hot enough to vaporize your eyeballs; likewise 100 gaud is gaudy enough to do the same. For an example of a 100-gaud map, see Map Rooftop |
3131
| insta | instagib, a game mutator for one-hit-kills, disabled by default. |
3232
| mat | materials define special properties of map volumes, such as filling an area with water or clipping. |
33-
| mod | moderator, a player with elevated [privileges](Privileges). Mod can also stand for client modifications. |
33+
| mod | moderator, a player with elevated ~~[privileges](Privileges)~~. Mod can also stand for client modifications. |
3434
| mpz | file format to store most content of a map, including all geometry, entity positions and lightmaps. |
3535
| muts | game mutators, special game rules that can be added and combined for a more diverse game experience. |
3636
| nade | grenade, a collectible explosive weapon. |
3737
| ogg | container format for vorbis audio, used for music and sound files. |
38-
| op | operator, a player with advanced [privileges](Privileges). Or just OverPowered. |
38+
| op | operator, a player with advanced ~~[privileges](Privileges)~~. Or just OverPowered. |
3939
| pzap | a typical taunt or chat comment, echoism of a rifle shot. |
4040
| runner | players with a preference for parkour and agile game-play, like race games or hit-and-run tactics in capture-the-flag or bomber-ball games. |
4141
| sg | shotgun, a short ranged loadout weapon. |

docs/Home.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@ redirect_from:
1212
---
1313
* TOC
1414
{:toc}
15-
[Red Eclipse](/) is an open-source arena shooter, built using the technology found in [Tesseract](http://tesseract.gg/) and [Cube Engine 2](http://cubeengine.com/). Offering an [innovative parkour system](Parkour-Guide), [distinct but all potent weapons](Weapons-Guide), and fast paced accessible gameplay.
15+
[Red Eclipse](/) is an open-source arena shooter, built using the technology found in [Tesseract](http://tesseract.gg/) and [Cube Engine 2](http://cubeengine.com/). Offering an ~~[innovative parkour system](Parkour-Guide)~~, ~~[distinct but all potent weapons](Weapons-Guide)~~, and fast paced accessible gameplay.
1616

1717
## New to Red Eclipse?
1818
- **[Frequently Asked Questions](FAQ)** - See if your question is one of the ones we're asked a lot.
1919
- **[Installation Help](Install-Guide)** - If you're stuck, these are our official instructions.
20-
- **[Gameplay Guide](Gameplay-Guide)** - Want to learn how to play? This is a good start.
21-
- **[Learn about the Weapons](Weapons-Guide)** - Each weapon is unique, learn the pros and cons.
22-
- **[Tips and Tricks for using Parkour](Parkour-Guide)** - Everyone loves running on walls, but there's more to learn.
23-
- **[Privilege Levels](Privileges)** - What those icons next to player names are all about.
20+
- **~~[Gameplay Guide](Gameplay-Guide)~~** - Want to learn how to play? This is a good start.
21+
- **~~[Learn about the Weapons](Weapons-Guide)~~** - Each weapon is unique, learn the pros and cons.
22+
- **~~[Tips and Tricks for using Parkour](Parkour-Guide)~~** - Everyone loves running on walls, but there's more to learn.
23+
- **~~[Privilege Levels](Privileges)~~** - What those icons next to player names are all about.
2424
- **[Official Maps](Official-Maps)** - Descriptions and recommendations for the included levels.
2525

2626
## Server Administration
27-
- **[Server Setup](Server-Setup)** - How to configure and run a Red Eclipse server.
28-
- **[Administration Guide](Admin-Guide)** - How to manage and moderate a server.
27+
- **~~[Server Setup](Server-Setup)~~** - How to configure and run a Red Eclipse server.
28+
- **~~[Administration Guide](Admin-Guide)~~** - How to manage and moderate a server.
2929
- **[Statistics System](Statistics-System)** - Information about the master server's global statistics system.
3030

3131
## Map Editing
32-
- **[Editing Basics](Editing-Basics)** - Learn how to start making your own maps in Red Eclipse.
33-
- **[Editing Reference](Editing-Reference)** - A detailed explanation of the available editor features.
32+
- **~~[Editing Basics](Editing-Basics)~~** - Learn how to start making your own maps in Red Eclipse.
33+
- **~~[Editing Reference](Editing-Reference)~~** - A detailed explanation of the available editor features.
3434

3535
## Development
3636
- **[Version 2.0](Information-for-v2)** - Find out more about the upcoming **v2.0**, featuring [Tesseract](http://tesseract.gg/).

docs/Install-Guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ If you get a permission denied error during install, right click the installer a
3737
- Debian/Ubuntu: `sudo apt-get install libsdl2-mixer-dev libsdl2-image-dev libsdl2-dev libfreetype-dev`
3838

3939
From the command line:
40-
- Clone the repositry and its submodules with `git clone --recurse-submodules https://github.com/redeclipse/base`
40+
- Clone the repository and its submodules with `git clone --recurse-submodules https://github.com/redeclipse/base`
4141
- Enter the working directory with `cd base`
4242
- Compile with `make -C src install -jN`, with `-jN` being set to the number of cores your CPU has (e.g. `-j4` for a quad core system)
4343
- Enter the source directory with `cd src`

docs/Mutator-Tips.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ redirect_from:
1010
---
1111
* TOC
1212
{:toc}
13-
For those mutators specific to certain game modes, see the corresponding [mode pages](Modes-and-Mutators).
13+
For those mutators specific to certain game modes, see the corresponding ~~[mode pages](Modes-and-Mutators)~~.
1414

1515
## FFA
1616
<img src="images/modes/ffa.png" width="64px"/>
@@ -129,7 +129,7 @@ For those mutators specific to certain game modes, see the corresponding [mode p
129129

130130
- As the name implies, the purpose of this mutator is to provide an added layer of difficulty to a match through handicaps.
131131
- As with Survivor or Duel, there is no health regeneration in Hard matches. Tread carefully and make your shots count.
132-
- No matter what radar style you have chosen, it is completely disabled during a Hard match. The element of suprise rests in the hands of every player.
132+
- No matter what radar style you have chosen, it is completely disabled during a Hard match. The element of surprise rests in the hands of every player.
133133
- Remember, not only have you lost track of players and teammates, you also won't see explosives (including the rocket) spawn on your radar. Check their spawn points frequently.
134134
- For a truly brutal Red Eclipse, try a Free-for-All Freestyle Onslaught Hard Deathmatch on a large map.
135135

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: Editing Basics
2+
title: Editing: Basics
33
layout: docs
4-
origfile: Editing-Basics.md
5-
origtitle: Editing-Basics
6-
permalink: /docs/Editing-Basics
4+
origfile: editing/Basics.md
5+
origtitle: Basics
6+
permalink: /docs/editing/Basics
77
redirect_from:
8-
- /docs/Editing_Basics/
9-
- /wiki/Editing_Basics/
8+
- /wiki/editing/Basics/
109
---
1110
* TOC
1211
{:toc}
@@ -144,3 +143,13 @@ A menu for finding available mapmodels can be shown by pressing `F6`. Scroll dow
144143
#### The REEE
145144

146145
The *Red Eclipse Editing Encyclopedia*, found within the editing menu (press `E`). This menu displays an alphabetically ordered list of available commands related to editing, along with a description of usage, and the parameters each command expects.
146+
147+
### More on map editing
148+
149+
[Blendmaps](Blendmap) - Overlapping, and blend textures together.
150+
[Waypoints](Waypoints) - Letting bots navigate around the map.
151+
[Entities](Entities) - Managing particles, lighting, game specific objects, and more.
152+
[General FX](Fx) - General effects when map making.
153+
[Particle FX](Fx-Particle) - Using particle effects on map
154+
[Other FX](Fx-Other) - More effects to using on maps.
155+
[Level FX](Fxlevels) - How to increasing performance for users on lower settings.
Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: Editing Blendmap
2+
title: Editing: Blendmap
33
layout: docs
4-
origfile: Editing-Blendmap.md
5-
origtitle: Editing-Blendmap
6-
permalink: /docs/Editing-Blendmap
4+
origfile: editing/Blendmap.md
5+
origtitle: Blendmap
6+
permalink: /docs/editing/Blendmap
77
redirect_from:
8-
- /docs/Editing_Blendmap/
9-
- /wiki/Editing_Blendmap/
8+
- /wiki/editing/Blendmap/
109
---
1110
* TOC
1211
{:toc}
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
title: Entities
2+
title: Editing: Entities other
33
layout: docs
4-
origfile: Entities.md
5-
origtitle: Entities
6-
permalink: /docs/Entities
4+
origfile: editing/Entities-other.md
5+
origtitle: Entities-other
6+
permalink: /docs/editing/Entities-other
77
redirect_from:
8-
- /wiki/Entities/
8+
- /docs/editing/Entities_other/
9+
- /wiki/editing/Entities_other/
910
---
1011
* TOC
1112
{:toc}
Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: Editing Entities
2+
title: Editing: Entities
33
layout: docs
4-
origfile: Editing-Entities.md
5-
origtitle: Editing-Entities
6-
permalink: /docs/Editing-Entities
4+
origfile: editing/Entities.md
5+
origtitle: Entities
6+
permalink: /docs/editing/Entities
77
redirect_from:
8-
- /docs/Editing_Entities/
9-
- /wiki/Editing_Entities/
8+
- /wiki/editing/Entities/
109
---
1110
* TOC
1211
{:toc}
@@ -67,7 +66,7 @@ The `light` entity is used to add point lights. They can be configured with the
6766
| 8 | palette | The type of colour palette to use
6867
| 9 | palindex | The index of the chosen colour palette
6968
| 10 | variant | Determines if the entity appears in both ~~[map variants](Editing-Variants)~~ or only one
70-
| 11 | fxlevel | Determines if the entity will be rendered based on the users [map effects](Editing-Fxlevels) setting
69+
| 11 | fxlevel | Determines if the entity will be rendered based on the users ~~[map effects](Editing-Fxlevels)~~ setting
7170

7271
## Lightfx
7372

@@ -111,7 +110,7 @@ Rails are a new feature in the development branch. Entities can be ~~[linked](Ed
111110

112111
The `route` entities are used to add possible paths that the player can follow to complete a lap in ~~[Race](Race)~~ mode.
113112

114-
These are easier to place by using `/droproute 1` similar as to how [waypoints](Editing-Waypoints) are placed.
113+
These are easier to place by using `/droproute 1` similar as to how ~~[waypoints](Editing-Waypoints)~~ are placed.
115114

116115
## Sound
117116

@@ -135,7 +134,7 @@ A trigger is used to create events. For example; A proximity trigger will allow
135134

136135
`/newent weapon`
137136

138-
The `weapon` entity is used to place [weapon](Weapons-Guide) spawns within a map.
137+
The `weapon` entity is used to place ~~[weapon](Weapons-Guide)~~ spawns within a map.
139138

140139
## Wind
141140

0 commit comments

Comments
 (0)