Fandom

OpenArena

Readme Model

373pages on
this wiki
Add New Page
Talk1 Share

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.

Here you can find examples for making "readme" files for stuff created by you (maps, models, etc.). Of course, following these templates is not mandatory.

Map readme file exampleEdit

Here's a readme file model. It should contain important information about your map. This template is based on LvL's readme template and is adapted in order to fit OA.

============================================================
Title: <map title>
Mapname: <mapname>.bsp
File: <filename>.pk3
Author: <author name>
Email address: <e-mail address>
URL: <website>
Description: <map description>

============================================================
Play information

Free For All: <yes or no>
Team Deathmatch: <yes or no>
Tournament: <yes or no>
Capture The Flag: <yes or no>
One Flag CTF: <yes or no>
Overload: <yes or no>
Harvester: <yes or no>
Elimination: <yes or no>
CTF Elimination: <yes or no>
Last Man Standing:<yes or no>
Double Domination:<yes or no>
Domination: <yes or no>
Botplay: <yes if it includes .aas file, no if it doesn't>
New Sounds: <yes if it has new sounds, no if it hasn't>
New Graphics: <yes if it has new textures, no if it hasn't>
New Music: <yes if it has new music, no if it hasn't>

How to play: Unzip the pk3 file into the baseoa folder
Start OpenArena
Select <filename> from the Skirmish or Create Server menu
============================================================
Info

<trivia about your map and/or the game itself>

============================================================
Construction

base: <???>
editor: <Q3Radiant/GTKRadiant/NetRadiant/QuArK/etc...>
other progs: <other programs such as image/sound editors, list one per line>
know bugs: <list if there are some>
build time: <how much the map took to be built>

============================================================
Credits

<list of people who helped/supported you>

============================================================
Other maps by <author name>

<list of other maps you've made in the past>

============================================================
Distribution / Copyright / Permissions

Copyright (c) <year> <author name>, <e-mail address>
All rights reserved.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

============================================================

Map readme file blank modelEdit

Here's a blank model which can be pasted into a new file and added info accordingly.

============================================================
Title:
Mapname:
File:
Author:
Email address:
URL:
Description:

============================================================
Play information

Free For All:
Team Deathmatch:
Tournament:
Capture The Flag:
One Flag CTF:
Overload:
Harvester:
Elimination:
CTF Elimination:
Last Man Standing:
Double Domination:
Domination:
Botplay:
New Sounds:
New Graphics:
New Music:

How to play: Unzip the pk3 file into the baseoa folder
Start OpenArena
Select from the Skirmish or Create Server menu
============================================================
Info



============================================================
Construction

base:
editor:
other progs:
know bugs:
build time:

============================================================
Credits



============================================================
Other maps by



============================================================
Distribution / Copyright / Permissions

Copyright (c) ,
All rights reserved.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

============================================================

Still to doEdit

Character Model readme file exampleEdit

<This has to be done yet...>

Character Model readme file blank modelEdit

<This has to be done yet...>

Character Skin readme file exampleEdit

<This has to be done yet...>

Character Skin readme file blank modelEdit

<This has to be done yet...>

Other Model (mapobject, weapon, item...) readme file exampleEdit

<This has to be done yet...>

Other Model (mapobject, weapon, item...) readme file blank modelEdit

<This has to be done yet...>

Music readme file exampleEdit

<This has to be done yet...>

Music readme file blank modelEdit

<This has to be done yet...>

Also on Fandom

Random Wiki