empire/empserver
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update for current code. Minor edits.

Browse source
This commit is contained in:
Markus Armbruster 2006-06-14 18:02:20 +00:00
parent cce7f179b8
commit c05ecb8781
2 changed files with 19 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/econfig
View file

@ -77,11 +77,8 @@ file next to your econfig, then name the file in custom_tables. Do
*not* edit the default table in-place! That bypasses important *not* edit the default table in-place! That bypasses important
consistency checks. consistency checks.
The server lets you customize more tables than the ones in builtindir. Be careful not to put `holes' into tables, e.g. by commenting out
This is not recommended at this time. You can use the xdump command entries. That doesn't work yet.
to dump the default table to a file. The resulting table is in
machine-readable form, and may not be portable between different
server versions.
A word of caution: Just because you can customize something doesn't A word of caution: Just because you can customize something doesn't
mean you should! The server makes an effort to catch mistakes that mean you should! The server makes an effort to catch mistakes that

39
doc/xdump
View file

@ -2,7 +2,7 @@ Introduction
Empire is designed as a smart server with dumb clients. An Empire Empire is designed as a smart server with dumb clients. An Empire
client need to know nothing about the game. Even telnet would do. In client need to know nothing about the game. Even telnet would do. In
fact, emp_client is just as a slightly specialized telnet. fact, emp_client is litte more than a slightly specialized telnet.
In such a design, presentation is in the server, and it is designed In such a design, presentation is in the server, and it is designed
for human consumption. Ideally, presentation and logic are cleanly for human consumption. Ideally, presentation and logic are cleanly
@ -26,7 +26,7 @@ rules?
Except for commands that actually don't do anything. There's a useful Except for commands that actually don't do anything. There's a useful
class of such commands: commands to show game configuration and state class of such commands: commands to show game configuration and state
without altering it. The only game rules involved are those that without altering it. The only game rules involved are those that
govern who gets to see what. Ensuring that those are satisfied is govern who gets to see what. Ensuring that those are obeyed is
tractable. tractable.
Empire has had one such command since the beginning: dump. Empire Empire has had one such command since the beginning: dump. Empire
@ -45,9 +45,9 @@ migrate games to different machines or even, with some text mangling
perhaps, different server versions. We will see below that xdump perhaps, different server versions. We will see below that xdump
isn't quite sufficient for that, but it's a start. isn't quite sufficient for that, but it's a start.
If you can import game state, you can import game configuration, or in Means to import game configuration let you customize your game without
other words: customize your game. As we will see, configuration files recompiling the server. As we will see, configuration files have
have different requirements, which xdump doesn't satisfy without some different requirements, which xdump doesn't satisfy without some
extensions. extensions.
If game import code can edit everything, then a deity command capable If game import code can edit everything, then a deity command capable
@ -147,11 +147,11 @@ symbol table. You decode a symbol set value by looking up its bits
Some integer fields are actually keys in other tables. For instance, Some integer fields are actually keys in other tables. For instance,
ship field type is a key in the table of ship types ship-chr, and ship field type is a key in the table of ship types ship-chr, and
plane field ship is a key in the ship table. Key value -1 is special: plane field ship is a key in the ship table. Key -1 is special: it's
it's a null key. Meta-data encodes these table reference just like a null key. Meta-data encodes these table reference just like for
for symbols: the meta-data has the ID of the referenced table, and symbols: the meta-data has the ID of the referenced table, and that
that table has the key in the leftmost column. Obviously, that table has the key in the leftmost column. Obviously, that leftmost
leftmost column is a table key as well, referencing the table itself. column is a table key as well, referencing the table itself.
A table with its key in the leftmost column can be dumped partially. A table with its key in the leftmost column can be dumped partially.
Without such a key, you need to count records to find the record Without such a key, you need to count records to find the record
@ -259,7 +259,7 @@ of xdump meta T are:
* flags: The field's flags, a symbol set. Flags are: * flags: The field's flags, a symbol set. Flags are:
- "deity", field visible only to deities - "deity", field visible only to deities
- "extra", field not to be dumped - "extra", field not to be dumped
- "const", field cannot be changed (see xundump below) - "const", field cannot be changed
- "bits", field is a symbol set, field type must encode symbol "d", - "bits", field is a symbol set, field type must encode symbol "d",
field table must not be -1. field table must not be -1.
@ -513,11 +513,12 @@ fields may be repeated. Repeated fields must be the same in all
parts. Naturally, the parts together must provide the same fields as parts. Naturally, the parts together must provide the same fields as
a table that is not split. a table that is not split.
Rationale: This is the cure for long lines. Line continuation would Rationale: This is to let you avoid long lines. Line continuation
be simpler, but turns out to be illegible. Requiring record uid is syntax would be simpler, but turns out to be illegible. Requiring
not technically necessary, as counting records works the same whether record uid is not technically necessary, as counting records works the
a table is split or not. Except humans can't count. Perhaps this same whether a table is split or not. Except humans can't count.
should be a recommendation for use rather than part of the language. Perhaps this should be a recommendation for use rather than part of
the language.
EBNF changes: EBNF changes:
@ -601,12 +602,6 @@ See src/lib/global/*.config for examples.
Human-readable xdump still has its shortcomings: Human-readable xdump still has its shortcomings:
* Symbolic references work only with symbol tables. Consider sect-chr
selector prd, which is a key for table product. xdump should
support use of product selector sname values as keys. Same for
product selectors ctype and type, which should support item selector
mnem values as keys.
* item selector pkg is an array indexed by values in symbol table * item selector pkg is an array indexed by values in symbol table
packing. The column header should support symbolic index values packing. The column header should support symbolic index values
rather than numbers. rather than numbers.