Custom Systems - Revision history

Impaktor: /* Running the Editor */

2024-02-03T11:36:15Z

‎Running the Editor

Impaktor: /* Design philosophy */

2024-02-02T15:36:00Z

‎Design philosophy

Impaktor: /* Running the Editor */

2024-02-02T14:33:09Z

‎Running the Editor

Impaktor at 12:59, 2 February 2024

2024-02-02T12:59:25Z

Show changes

Zonkmachine: Fix dead links

2023-07-05T21:03:30Z

Fix dead links

Zonkmachine: /* CustomSystemBody */ Fix dead link

2023-07-05T20:59:47Z

‎CustomSystemBody: Fix dead link

Impaktor: Add general design tips for inclusion in main game

2019-10-02T10:28:00Z

Add general design tips for inclusion in main game

Nozmajner: /* Methods */ Adding an explanation to the numbers like radius and such

2019-09-29T11:11:34Z

‎Methods: Adding an explanation to the numbers like radius and such

Nozmajner: Fixing the mangledness, but adding what I added at that time. Undo revision 3188 by Nozmajner (talk)

2017-08-21T19:10:08Z

Fixing the mangledness, but adding what I added at that time. Undo revision 3188 by Nozmajner (talk)

Show changes

Nozmajner: Updating the in-sector coordinates part.

2017-02-24T12:35:13Z

Updating the in-sector coordinates part.

Show changes

← Older revision		Revision as of 11:36, 3 February 2024
Line 18:		Line 18:
	./editor --system		./editor --system

−	Note (2024-02): If Microsoft Windows flags the binary as malicious software, it's not. ~~Really. Trust us, bro. If not: you~~ can [https://github.com/pioneerspacesim/pioneer/tree/master/src/editor inspect the source] and compile your own.	+	Note (2024-02): If Microsoft Windows flags the binary as malicious software, it's not. You can always [https://github.com/pioneerspacesim/pioneer/tree/master/src/editor inspect the source] and compile your own.

@@ Line 12: / Line 12: @@
 * No "non-physical" systems: meaning, all systems should be "sane", from an astronomical stand point.
 * If your system is an existing star, model it as closely as possible to real astronomical data, e.g. star size, temperature, color, does it have known exo-plantes? Does it have multiple names, e.g. propper name, and star catalouge name? If so, use  <tt>other_names()</tt> property to overload it (e.g. see source for wolf_359-system for code example)
 == Running the Editor ==

@@ Line 15: / Line 15: @@
 == Running the Editor ==
 Launch the editor from where the editory binary is located with:
-     editor --system
+     ./editor --system
 Note (2024-02): If Microsoft Windows flags the binary as malicious software, it's not. Really. Trust us, bro. If not: you can [https://github.com/pioneerspacesim/pioneer/tree/master/src/editor inspect the source] and compile your own.

@@ Line 20: / Line 20: @@
 <blockquote>s = CustomSystem:new(name, star_types)</blockquote>
 *'''name''' (string): system name.
-*'''type''' (table): up to four star types. Limited to <tt>BodyType</tt> <tt>STAR_*</tt> types, see [http://eatenbyagrue.org/f/pioneer/codedoc/files/LuaConstants-cpp.html#Constants.BodyType Lua constants] for a list.
+*'''type''' (table): up to four star types. Limited to <tt>BodyType</tt> <tt>STAR_*</tt> types, see [https://codedoc.pioneerspacesim.net/#File:src/lua/LuaConstants.cpp:Constants.BodyType Lua constants] for a list.
 *'''returns''': a new <tt>CustomSystem</tt> object.
@@ Line 44: / Line 44: @@
 Sets the system government type. It not specified, defaults to Polit.GovType.NONE
-*'''type''': government type. Limited to <tt>PolitGovType</tt> types, see [http://eatenbyagrue.org/f/pioneer/codedoc/files/LuaConstants-cpp.html#Constants.PolitGovType Lua constants] for a list.
+*'''type''': government type. Limited to <tt>PolitGovType</tt> types, see [https://codedoc.pioneerspacesim.net/#File:src/lua/LuaConstants.cpp:Constants.PolitGovType Lua constants] for a list.
 *'''returns''': the <tt>CustomSystem</tt> object (for call chaining)

@@ Line 121: / Line 121: @@
 <blockquote>b = CustomSystemBody:new(name, type)</blockquote>
 *'''name''' (string): body name.
-*'''type''' (integer): body type. Limited to <tt>BodyType</tt> constants, see [http://eatenbyagrue.org/f/pioneer/codedoc/files/LuaConstants-cpp.html#Constants.BodyType Lua constants] for a list.
+*'''type''' (integer): body type. Limited to <tt>BodyType</tt> constants, see [https://codedoc.pioneerspacesim.net/#File:src/lua/LuaConstants.cpp#Constants.BodyType Lua constants] for a list.
 *'''returns''': a new <tt>CustomSystem</tt> object.

← Older revision		Revision as of 10:28, 2 October 2019
Line 1:		Line 1:

	This page describes the Lua API for defining custom star systems. If you're getting started you should look at the existing definitions in the <tt>data/systems</tt> folder of your Pioneer installation.		This page describes the Lua API for defining custom star systems. If you're getting started you should look at the existing definitions in the <tt>data/systems</tt> folder of your Pioneer installation.
		+
		+	== Design philosophy ==
		+
		+	A designed system can always be shared with the community (mainly SpaceSimCentral), but of course it is much more rewarding to see your custom designed system included in the game, and this is one of the easiest contributions you can make, and also easy for maintaners to test and merge. Ideally, at some point all the core systems are custom made.
		+
		+	Please see current custom systems as guide for the style we want for inclusion in master branch, but in short:
		+	* Do not infringe on trademarks: no Star Wars, Star Trek, Elite/Frontier, Nintendo, references
		+	* No aliens please. There can be alien life forms, like fauna, animals, but in general, we do not want "grays", or "E.T.". However, there can be tasteful hints to mysteries in system description, e.g. think of the writings of Arthur C. Clarke.
		+	* If you include some history of the system in the description, then make sure it fits with the lore/time line of [[Pioneer_Universe]].
		+	* No "non-physical" systems: meaning, all systems should be "sane", from an astronomical stand point.
		+	* If your system is an existing star, model it as closely as possible to real astronomical data, e.g. star size, temperature, color, does it have known exo-plantes? Does it have multiple names, e.g. propper name, and star catalouge name? If so, use <tt>other_names()</tt> property to overload it (e.g. see source for wolf_359-system for code example)

	== CustomSystem ==		== CustomSystem ==

← Older revision		Revision as of 11:11, 29 September 2019
Line 129:		Line 129:

	<tt>b:seed(42)</tt>		<tt>b:seed(42)</tt>
		+
		+	'''Our system uses a fixed-point number system to avoid differences in represenation on various platforms... basically PC/Mac/Linux/ARM/x86 or whatever all produce slightly different results of floating point operations, fixed point maths avoids that.'''
		+
		+	So you need to convert the values to fixed so 0.5330717313 -> (533, 1000) which is the same as 533 / 1000 = 0.533
		+	If you wanted more precision to include the `07` for example, then (53307, 100000) = 53307 / 100000 = 0.53307 (In the example, the radius of Mars is given)

	'''radius'''		'''radius'''