Welcome to the Beginners Wiki Guide, we hope to inform you of what you need to obtain and access the information and assets you need to contribute to this wiki.
Contents
- 1 Ruling on adding content to the wiki
- 2 Text colour and formats templates
- 3 Images
- 3.1 Obtaining Icons
- 3.2 Obtaining Textures
- 3.3 Image Uploading (important)
- 3.4 Image Gallery
- 4 Tables
- 4.1 Symbols
- 4.2 Formatting
- 5 Additional
Ruling on adding content to the wiki[ | ]
make sure that when adding content it follows the preferred rules of Failbetter Games for all their wikis as described in the link below.
http://echobazaar.wikidot.com/rules
Text colour and formats templates[ | ]
Here is a list of templates which allow for an easier way of formatting the wiki while keeping up the standard text format. Identify what it is you are editing and see what template can be used. These templates were designed by MestreLion, Tagaziel and S3Ld0m
The following is just a basic list, you may browse and explore for more.
- Use {{Action}} for actions:
- Take him with you action.
- Use {{Game note}} for game notes:
- Game note: This is a game note.
- Use {{trigger event}} and {{trigger location}} for actions that triggers events or move to locations:
- Use {{qty}} for coloring basic positive and negative outcomes:
- +10 x Fuel
- +10 x Terror
- -10 x Fuel
- -10 x Terror
- Use the "to" for a range of outcomes of the same result. Example:
- -1 to +5 x Fuel
- Or, for consistency, use {{link range}} with no icon.
- Use {{link qty}} for a combination of colored quantity, link, and optionally and icon:
- Use {{link range}} for ranges:
- Use {{quality}} in descriptions containing quality references:
- Help [Pigmote Isle: Mastery] resolve a dilemma
- Use {{link status}} to format the text of the Quality:
- Favours: A Proposal from a Man of Business = 6 [You accepted the proposal]
- Or a combination of {{link icon}} and {{status}} for inequalities:
- Use {{quality status}} to format a list of Quality statuses:
- [3] Conflicted
- [4] Argumentative
- [5] Content
- [6] Optimistic
- Use {{color}} for colored text. For instance, yellow for conditional results:
- "A good night out" OR "A marvelous night out".
In interaction tables, use the templates {{Style inner header}}, {{style inner cell}}, {{action title}} and {{effect title}}. Example:
Interaction | Unlocked by | Effects | Notes |
---|---|---|---|
Open the treasure |
| Failed event | Game note: This will increase your Hearts Other notes, hints and observations that are not in game files... |
A Poor Result
| |||
Successful event (30%) | |||
Somewhat Better
| |||
Rare Event (1%) | |||
An Amazing Treasure!
|
Other suggestions not (yet) available as templates:
- Use italic and quotes for the text result outcomes. Example:
- The outcome result is "A good night out".
- Use bold and grey for status changes. Example:
- A Proposal from a Man of Business is Accepted.
- Use italic and grey for status getting disabled. Example:
- Something Awaits You is Inactive.
Images[ | ]
Obtaining Icons[ | ]
All the icons, avatars, etc used in the game are stored seperately from the .assets files of the game.
To find these files on Windows go to:C:\Users\*USERNAME*\AppData\LocalLow\Failbetter Games\Sunless Sea\images\sn\icons
Replace C with the disk you have installed your copy of Windows on, *USERNAME* with the user account name you are using.
Obtaining Textures[ | ]
Island graphics, wallpapers, backgrounds, effects, etc used in the game are stored in the .assets files found in the games directory. To obtain these files you must extract the .assets file, "resources.assets"
You can find the .assets files on Windows by going to:
- Installation*\Steam\SteamApps\common\SunlessSea\Sunless Sea_Data
Replace *Installation* with the disk and folder location you installed Steam on, for example "C:\Program Files (x86)\"
To extract from the .assets file you need a program capable of doing this. Personally I use Unity Assets Explorer 1.3, feel free to provide any alternative you may know of. The texture files are stored in the .TEX files which needs to be converted to .DDS files.
Image Uploading (important)[ | ]
To make sure that all images follow the same standard there are a few things you must know when uploading images
- The file should be the original .png found in the image folder. No Jpgs.
- The filename should not be altered, keep the original name, don't rename to fit the article it's used for.
- Only upload the small or large version of the images, not the medium-sized. (the ones with "***small" or "***gaz" at the end of the name)
- In the file description on the file page add the category of the file.
- [[Category: Sunless Sea small images]] for small images
- [[Category: Sunless Sea gaz images]] for large images
Image Gallery[ | ]
You can find the library of all uploaded images here:
- http://sunlesssea.gamepedia.com/Category:Sunless_Sea_images
Tables[ | ]
On most pages you will have to edit (or make) a table, this section will explain the basics of how to create and deal with a table.
Ps: It's easiest to learn how to deal with tables by experimenting. Edit a table and press preview to see what the changes did, try to find the logic in it and you will get the hang of it, and when worst comes to it you can just borrow from a different table that has done what you wanted and just edit the information.
Symbols[ | ]
Symbol | Effect | Notes |
---|---|---|
| A new row | You will need as many row symbols as there are columns for one interaction. In this case we have "Symbol" "Effect" and "Notes", meaning we need 3 x |. The exception to the rule is when you're dealing with rowspanning, you will need more. |
| Row closer | Marks the end of a row and the beginning of a new one. Make sure it's always present at the end of the table and each of its rows. |
| Table starter | Marks the start of a table. Make sure it's always present at the start of the table. It will always be accompanied with the css styling of the table declaring the amount of columns present and their names. |
| Table closer | Marks the end of a table, making sure text can flow freely below it without expecting columns and rows. Make sure it's always present at the end of a table. |
|
| Makes a bulletin point, make sure this symbol is on it's own line below the | symbol, otherwise it will not work. |
|
| Makes a numbered point, make sure this symbol is on it's own line below the | symbol, otherwise it will not work. |
| Italics | Used for most referenced in-game text. |
| Bold | "One must be bold to travel the zee..." |
Formatting[ | ]
Additional[ | ]
Please add information deemed useful