Systems

System Submissions Checklist for Discovery Mod

Checklist v12.08.2009 by Igiss, igissmail@gmail.com

Please provide some basic info about yourself and your submission. Fields marked with * are obligatory. Other fields are optional.

Submission author nickname (for credits):*

Submission author real name (for credits):

Nicknames of other contributors, if available:

Submission author e-mail address:*

Submission author Skype ID:

System code (Xx01 format):*

System name:*

Submission date:*

Version number:

Infocard range(s) used for system infocards:



N Requirement Notes



1 Submission files

1.1 You've checked that this version of checklist, infocards.zip Checklist rules have higher

and dsy_design.xls are the latest available from Discovery priority than submisison rules

forums. listed elsewhere.



Updates are listed in this thread:

http://discoverygc.com/forums/index.php?showtopic=4074

1.2 You are aware that false or incomplete information provided If you are not sure what some of

in this document will prevent your system from appearing in the items mean, contact Igiss.

the mod.

1.3 Submission and this checklist (filled) are going to be mailed

to igissmail@gmail.com, specifying name of the system, and

name of submitter in the form that he/she wants the name to

be credited.

1.4 Your system info is present on

http://discoveryfl.com/wiki/index.php/New_Systems wiki

page.

1.5 Submission consists of one .zip (or .rar) archive.

1.6 Submission archive contains only .ini and .txt files plus this Including other files must be

checklist. discussed with Igiss before

submitting.

1.7 The archive contains the DATA folder where new .ini files

reside.

1.8 Structure of the DATA folder in the submission is replica of

Freelancer's DATA folder. All .ini files reside where they

should in game.

1.9 DATA folder does not contain any excess empty folders, Only exception is main .ini of the

unmodded files. DATA folder only contains (1) new .ini files system you submit. It's not new

for the system and (2) .txt files for amending existing .ini files. but should be submitted in whole,

not in parts.

1.10 Modified parts of .ini files (for example, mbases.txt) reside in If not sure which sections were

same folders where original .ini reside. They don't contain modified, include more, not less.

sections that were not modified.

1.11 Double line breaks between .ini sections were removed This applies both to whole .ini files

from all .ini files and parts of .ini files included into and to amended parts.

submission.

1.12 Line breaks in the end of all .ini files were removed as well.

1.13 Following files must be present in root: infocards.txt contains all your

infocards.txt infocards. Format should be the

dsy_checklist.xls same as in template:

comments.txt http://discoveryfl.com/files/infocar

basetemplates.txt - file that lists base templates, in this ds.zip

format:

XX01_01_Base basetemplates.txt should not be

Sample base name included if you custom build all

copy from your bases.

Li01_01_Base

Manhattan

1.14 Following files must be present in DATA folder: Do not include base or room files

\DATA\Interface\InfocardMap.txt if you want me to set them up

\DATA\Universe\Universe.txt using existing base template.

\DATA\Universe\Systems\XX01\XX01.ini

1.15 Following types of files are optional:

\DATA\Equipment\market_*.txt

When you add asteroid fields/nebulas:

\DATA\Solar\ASTEROIDS\

\DATA\Solar\NEBULA\

When you add custom bases:

\DATA\Universe\Systems\XX01\Bases\...

\DATA\Missions\mBases.txt

1.16 Following additional files must be present: Presence of infocards.txt and

infocards.txt dsy_checklist.xls is essential.

dsy_checklist.xls Comments.txt is optional,

comments.txt - optional, if you have comments basetemplates.txt is needed when

basetemplates.txt - file that lists base templates, in this you use standard templates for

format: bases.

XX01_01_Base

Sample base name

copy from

Li01_01_Base

Manhattan

1.17 All pairs of infocards for planets and bases that contain basic Example:

information and detailed descriptions are included into Map = 461452, 461453

DATA\Interface\InfocardMap.txt Map = 461455, 461456

1.18 Comments.txt file in your submission must provide extensive

information on the file entries and files that you are removing

from the system. This might include:

Field files from \DATA\SOLAR\

Base entries in mBases.ini

InfocardMap.ini entries etc

1.19 All .ini files are based off Discovery files available in the Contact developer if closed beta

latest Discovery version available. has already started.

1.20 Check that none of the files and folders in your submission

are marked as "Read-only".

1.21 Check if none of your files contain UNIX line breaks. You can To fix this, use Format>Convert to

see the UNIX line breaks when you open your files in MS Windows option in Notepad++. If

Notepad (box-like symbols will be visible in places where line N++ only enables you to convert

breaks are normally present). to UNIX, convert to UNIX and then

back to Windows.

2 Infocards

2.1 Infocards in the submission comply to rules listed in See 1st post, sections II-IV.

http://discoverygc.com/forums/index.php?showtopic=4074 Checklist has a priority.

2.2 Infocards are included into a separate infocards.txt file with Template file:

proper formatting. Formatting and .txt file outline match the http://discoveryfl.com/files/infocar

example provided. ds.zip

For convenience, infocards.txt file may include code for new bases. For example, you may put internal name of

the base (LI09_04_Base) next to its name infocard. You can also note if the base template has a shipdealer

(meaning that it sells ships).

2.3 Range of infocard numbers for the system was borrowed from If there's no range specified,

dsy_design.xls. contact developer.

2.4 You used FLED-IDS program to check that all infocard Example: You want to use number

numbers you used were not already occupied by any 481010 for a base name. Check if

infocards. it contains any name or info. If

yes, skip it and check next

2.5 If you rename a base or an object, do not assign new number(s). base with name

You rename

infocard numbers, rather use old ones . New name must be 481090, info 481091, 481092.

placed where old name was, same applies to info. New infocards should be placed at

2.6 If you delete a base or an object, it is recommended to re-use Example: You delete base with

its infocard numbers for new objects. Same rule as in 2.5 info assigned to 481091 and

applies: where the old name was, only name can be, where 481092. You cannot use those

info was, info can be. numbers for new names, only for

2.7 All infocard texts were proofread prior to submission, at least info.

using Microsoft Word.

2.8 You used following object name patterns for fields:

*** Asteroid Field

*** Field

*** Cloud

*** Ice Field

*** Debris Field

*** Dust Field

2.9 In the system ini file, correct infocard numbers are included.

They match infocard numbers from your .txt file precisely.

2.10 You checked that no FL Explorer default infocard numbers Search for name/info = 524(.*),

(524*** and 589*** for new objects, ids_info = 66069 for name/info = 589(.*), ids_info =

planets are typical examples) remain in your submission. 66069 prior to submitting. (.*) is a

regular expression for any

symbols.

2.11 Check that you don't include any infocards already present in FL Explorer will assign existing

original game or Discovery. Examples: "New York Jump number itself if it finds required

Gate". name in vanilla infocard dlls.

2.12 Infocards don't have any line breaks within them. To create a This means that all text and code

line break in the in-game text, use code: for infocard must appear in one

  line in your infocards.txt.

2.13 Do not use diacritics (á) and special symbols (&) in infocard  & must be used instead of &

texts.

2.14 Special description elements (like degrees symbol for planet Check that "A.S." is used, not

infocards) and abbreviations are left intact in new infocards. "A.S".



2.15 Straight apostrophe - ' - and straight quote - " - must be used

in all infocards.



Using the following symbols: „ ‟ “ ” « » is not allowed.



2.16 NPC names that you submit have correct NPC name If your Notepad does not allow to

separator. To edit NPC names, use MS Notepad (in most do this, you can submit NPC

other editors, separator is interpreted as a line break and is names with line breaks instead of

invisible). separators.

2.17 You do not submit any files in binary format (e.g. renamed In case you need to re-use a

versions of planetary backgrounds) without a specific reason. binary asset, you need to link to

original asset instead of copying

it.

3 Design/Testing Requirements

3.1 All areas, bases and encounters of the system were tested in- Use a separate Freelancer

game before submission . No issues were found while testing. installation to test.



3.2 No objects in the system cause lag, graphical issues, and All areas of the system were

crashes. checked.

3.3 You did not submit base files if they are exact copies of name of this text file is

existing Freelancer bases. Instead, you provide a text file that basetemplates.txt (see item 1.13)

specifies name and location of bases that you wish to be

copied to your system.

3.4 If you make a custom base with your own NPCs, you

guarantee that in-game testing showed no errors or glitches

with those NPCs. NPC names are provided in the

infocards.txt file in correct format.

3.5 You have the latest version of dsy_design.xls document

available from Discovery forums, and you used it for finalizing

your submission.

3.6 There are no patrol paths in your system. If you submit a system with patrol

paths, they all will be removed

without exceptions.

3.7 You've compared your system .ini with any other system Check system lights, dust, music

already included into Discovery. You are sure that no etc.

important variables that set basic system properties are

missing.

3.8 Each asteroid field or nebula zone is linked to a separate file One file cannot be used for more

in DATA\Solar\Asteroids or \Nebula. than 1 zone.

3.9 Asteroid fields should have properly defined exclusion zones Nebulas might have exclusion

for all objects located inside. Objects that don't require zones as well.

exclusion zones are fighter wrecks and small misc objects.



3.10 If the sysetm contains nebulas, they were all checked for

disappearing when camera moves toward their edges.

Nebula templates from Br06 (Edinburgh) and Ku02 (Shikoku)

usually have this issue. Avoid them.

3.11 Check that casing of the system name and other objects is

preserved intact in the ini files. If "HI20" is used, it must not

be changed into "Hi20" or "hi20" anywhere.

3.12 Check if \Bases\Rooms folder for your system does not Example: FL Explorer will create

contain any repeated entries for same rooms. All room files files named BR22_03_bar.ini first

that you have in \Bases\Rooms must be linked to root base time you create a base, and will

file in \Bases. create BR22_03_Base_bar.ini if

you change the template.

3.13 Entries of "property_flags = " type in your system files were

checked for compliance with dsy_design.xls document.

3.14 Particle types used in your system files were checked for "Uncommon" are particles marked

compliance with dsy_design.xls document. You did not use with "-" in the file. They are

any uncommon particle types. invisible in-game.

3.15 Test docking with each base you create or expand. Both large This applies only to bases that

battleships and small ships must dock without any difficulties. have objects attached to them.

One-object bases don't need this.



3.16 You did not remove any bases, planets or other dockable

objects that were present in released versions of the mod.

3.17 All wrecks you add use custom loadouts defined in You can re-use "generic" loadouts

\DATA\SOLAR\loadouts.ini. You do not re-use pre-existing that do not contain any specific

loadouts. items.

3.18 All miners that you include are non-dockable solars. MISSION_SATELLITE objects

Following objects can be used: are selectable and can have

gas_miner_sat (SATELLITE) detailed descriptions attached to

gas_miner_mission_sat (MISSION_SATELLITE) them.

Roid_Miner (SATELLITE)

rm_Roid_Miner (MISSION_SATELLITE)

3.19 All comments are removed from your .ini files prior to If you need some comments in

submission. place, put "No" here and explain

why.

3.20 In FL Explorer, use Options>Check Inis (search for duplicate

nicknames) before you submit the system. Fix all reported

duplicate names, none must be present.

4 Code Restrictions

This section contains code restrictions that you must check your system against. Your files contain entries

similar to ones listed below as code samples. Use search, make sure that those entries are correct.

4.1 In universe.txt, all your new bases have correctly defined Each faction has its own entry. If

"BGCS_base_run_by = W**bF**" entries. Refer to "WbF you can't find one, refer to existing

Example" column in dsy_design.xls for correct values. bases of this faction.

4.4 Docking voices for your bases are no other than listed:

Robot - atc_leg_f01a

Male Base Voice - atc_leg_m01

Female Base Voice - atc_leg_f01

4.5 Docking characters that you used for bases are displayed where A-Liberty

correctly. If you are not sure, use robot characters: B-Bretonia

voice = atc_leg_f01a C-Rheinland

space_costume = , robot_body_ABCDE D-Kusari

E-Edge Worlds

4.7 You checked that your system does not contain Search for

pilot = pilot_solar_easiest pilot = pilot_solar_easiest

pilot = pilot_solar_easy pilot = pilot_solar_easy

entries that make solars (bases, weapon platforms) easy to

avoid. Use

pilot = pilot_solar_hard

or (preferred)

pilot = pilot_solar_hardest

4.8 All suns use following properties: Unless there are smaller suns with

atmosphere_range = 11000 smaller atmosphere. Damage

size = 10000 must not change anyway.

damage = 10000

4.9 The following 10 suns cause bugs and must not be used in Those suns are marked as "Do

any new systems: not use" in dsy_design.xls.

red_guant_sun

green_giant_sun

sm_red_sun

sm_blue_sun2

St03_sun

St01_yellow_sun

bw05_sun1

bw05_sun2

bw10_sun

ew06_sun2

4.10 All planets have "damage = 2000000" property set for their

atmospheres (death zones).

4.11 You checked that all FL Explorer default burn settings for Search for burn_color = 255, 255,

planets: 255

burn_color = 255, 255, 255 were replaced with normal

burn_color = 255, 222, 160

4.12 You checked that system lights are not set to Freelancer Search for color = 253, 230, 180

default value:

253, 230, 180

4.13 You checked that there are no jump holes or gates with Search for rotate = 0, 140, 0

default FL Explorer angle value:

0, 140, 0

4.14 If you change angle of jump hole/jump gate, make sure that If you set angle to X, on the other

the corresponding hole/gate in the neighboring system gets side angle will be X-180 (X+180

changed angle as well. for negative X and X=0). If angle

You can simply leave jump gates and holes with their pre- is 83, corresponding is -97.

defined angles.

4.15 FL Explorer can create only colored jump holes (red, orange,

white, green). It cannot create normal jump holes that are

multi-colored and generally look better. Check that you use

archetype = jumphole

unless you intend to use one-color JHs.



4.16 Normal spin value for planets is spin = 0, 0.001000, 0. Make Acceptable values lie between

sure that at least some of your planets are spinning. 0.003 and 0.0001.

4.17 Zones that must not have any population have

density = 0

relief_time = 0

entrues that should belong to sun and planet atmosphere

zones, mine fields, and other similar zones.

4.18 FL Explorer creates zones with empty encounter values by If the zone should not be an

default. Make sure that if the zone has encounter zone, completely

toughness = remove all entries starting from

density = toughness.

repop_time =

max_battle_size =

pop_type =

relief_time =

entries they also have faction entries.

4.19 Check that Other zones (fields, small

population_additive = true population zones) must not

entry is never used in your encounters. contain any population_additive

entries.

population_additive = false

should be used only for large encounter zones outside fields

(ambient background).

4.20 Your system must start with this entry: Note that while you must use

[SystemInfo] custom system name = (case

name = Xx01 matters!), local faction should stay

space_color = 0, 0, 0 br_p_grp unless you are making a

local_faction = br_p_grp Nomad system.

4.21 Search all your ini files for

[FLExplorer]

sections. Such sections and all associated entries must be

removed from all files that you submit.

4 Balance Restrictions

Items from "Balance Restrictions" sections can be "Failed" if In this checklist, however, you must still put "No"

you contacted Discovery lead modder (Igiss) and approved for each failed item. This will not prevent

all inconsistencies. including your submission into the mod.

5.1 System doesn't contain more than 6 bases or stations. All bases or stations belong to

system guardians.

5.2 System doesn't contain new suns.

5.3 System doesn't contain any populated planets.

5.4 One system doesn't contain more than 8 planets, moons and No more than 2 planets with a

planetoids. ring.

5.5 Excess lights are not used in the system. Standard is 1 light in the location

of main system sun.

5.6 No nebulas in the system. One nebula can be used, but no

bases or other objects can be placed inside.

5.7 Asteroid fields don't overlap. Asteroids are visible normally Number of asteroid fields is not

from range and from inside the field. Pattern of asteroids limited.

matches location of the system (ice in Barrier, etc).

5.8 No more than 30 weapon platforms are located in the system.



5.9 There are no unique objects in the system (Archs, Dyson

Sphere, etc).

5.10 There are no trade lanes in the system.

5.11 There are no large Newark-type stations in the system.

5.12 Only original Freelancer models are used for weapon

There are stations, and fields and debris fields in the system.

5.13 platforms, no large mineother objects.



5.14 Objects that are potential sources of profit are not available. "Mined-out" asteroid models

There are no mineable fields, except for cheapest resources. should not be used.

5.15 Total price of items looted from one wreck must not exceed

30K.

5.16 Bases don't contain any exclusive equipment.

5.17 There are no profitable trade routes in the system.

5.18 No more than 3 bases in the system sell ships.

5.19 There are no new jump holes and jump gates in the system.

5.20 There are no zones (encounters or fields) that exceed system

boundaries by more than 70%.

5.21 Encounters in the system belong only to the Guard faction Some other encounters may

and appropriate NPC faction. appear.

5.22 There are no objects with names not associated with actual Not applied to wreck names and

Earth geography or history. to other misc names.

5.23 There are no texts or places that contradict official Discovery

history.

5.24 The system and everything inside is based off original

Freelancer patterns and is compatible with general Discovery

design.

6 Rights & Duties

6.1 System was created by submitter without using code and

materials taken from any other Freelancer mods or other 3rd

party copyright sources.

6.2 System author is obliged to provide updates and bug fixes for

the system he/she submits, and is obliged to reply requests

related to the submission by mail in a reasonable amount of

time.

6.3 System author is obliged to submit the system before

specified deadlines. Updating the system is possible anytime

before the mod release, but Discovery Dev Team cannot

guarantee that such changes will be included into mod

releases.

6.4 Discovery Mod Team reserves full rights to delete, amend,

change and otherwise modify all submitted content. Only

guarantee available is that author's name will be listed in mod

credits, if at least one line of his/her code will be used.

If this checklist made you desperate, just send me FL Explorer picture of the system you wanted to submit. This

will resolve a lot of problems.

Original system submission rules: http://discoverygc.com/forums/index.php?showtopic=4074

d with * are obligatory. Other fields are optional.

List all bases that you add in this table.

Base code Base name

Xx01_01_Base Unknown Research Station

Xx01_02_Base Unknown Depot









Yes/No/NA Submitter's comments

mple, you may put internal name of

base template has a shipdealer

inst. Your files contain entries

ose entries are correct.

st, however, you must still put "No"

d item. This will not prevent

r submission into the mod.

system you wanted to submit. This



x.php?showtopic=4074