Ellpeck/Web
1
0
Fork 0
Code Issues Pull requests Releases Activity Actions

fixed readme references

Browse source
This commit is contained in:
Ellpeck 2019-11-23 18:16:03 +01:00
parent 2dd8ec9589
commit 2ae7d17a3e
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
foefrenzy/docs/tutorial.md
View file

@ -9,7 +9,7 @@ When creating a Map, two files are required:
- `Maps/MapName.xml`: This is a file containing information about the map, like which tile is which, where items can spawn, where players can spawn and so on. - `Maps/MapName.xml`: This is a file containing information about the map, like which tile is which, where items can spawn, where players can spawn and so on.
Note that the example file included has some more comments inside of it that explain what the different parts of the file do. Note that the example file included has some more comments inside of it that explain what the different parts of the file do.
- `Maps/Textures/MapName.png`: This file represents the actual layout of the map. You can edit it in an image editor of your choice. Each pixel represents one tile on the map, and the colors of the pixels represent what tiles should be placed there. The size of the image is the same as the size of the finished map. - `Maps/Textures/MapName.png`: This file represents the actual layout of the map. You can edit it in an image editor of your choice. Each pixel represents one tile on the map, and the colors of the pixels represent what tiles should be placed there. The size of the image is the same as the size of the finished map.
Note that, further down in this README, there is some information about which colors the game's default tiles have in the map image. Note that, further down on this page, there is some information about which colors the game's default tiles have in the map image.
Below is the file as well as the image for an example map with some comments that explain the structure in greater detail. To get started making your own map, it would be easiest to copy this information. Below is the file as well as the image for an example map with some comments that explain the structure in greater detail. To get started making your own map, it would be easiest to copy this information.
```xml ```xml
@ -22,7 +22,7 @@ Below is the file as well as the image for an example map with some comments tha
<ItemSpawnerDelay>5</ItemSpawnerDelay> <ItemSpawnerDelay>5</ItemSpawnerDelay>
<!-- The weather effect that is displayed on the map. Possible values are Snow and Rain --> <!-- The weather effect that is displayed on the map. Possible values are Snow and Rain -->
<WeatherEffect>Snow</WeatherEffect> <WeatherEffect>Snow</WeatherEffect>
<!-- The type of music that should be displayed on the map. Check the README for reference on all types --> <!-- The type of music that should be displayed on the map. Scroll down for reference on all types -->
<MusicTheme>Lava</MusicTheme> <MusicTheme>Lava</MusicTheme>
<!-- The map's global light modifier. This is the amount of "sunlight" that the map has, where 255 for each R, G, B value means "full light" and 0 means "no light". --> <!-- The map's global light modifier. This is the amount of "sunlight" that the map has, where 255 for each R, G, B value means "full light" and 0 means "no light". -->
<LightModifier> <LightModifier>
@ -51,7 +51,7 @@ Below is the file as well as the image for an example map with some comments tha
<Structure>Vine</Structure> <Structure>Vine</Structure>
</RawTileProperty> </RawTileProperty>
</TileProperties> </TileProperties>
<!-- This is the list of item spawners, their locations and the spawn pools they spawn from. Check the README for reference on spawn pools. --> <!-- This is the list of item spawners, their locations and the spawn pools they spawn from. Scroll down for reference on spawn pools. -->
<ItemSpawners> <ItemSpawners>
<RawItemSpawner> <RawItemSpawner>
<Location> <Location>
@ -112,7 +112,7 @@ Below is the file as well as the image for an example map with some comments tha
## Creating a Spawn Pool ## Creating a Spawn Pool
When creating a map, the items that can spawn at any given spawn point are referenced by their Spawn Pool. A spawn pool is basically just a list of items mapped to weights, where a higher weight means that the item will spawn more often, and a lower weight means that the item will spawn less often. When creating a map, the items that can spawn at any given spawn point are referenced by their Spawn Pool. A spawn pool is basically just a list of items mapped to weights, where a higher weight means that the item will spawn more often, and a lower weight means that the item will spawn less often.
Spawn pools are stored in `SpawnPools/PoolName.xml`. Note that the example file included has some more comments inside of it that explain what the different parts of the file do. Also note that, further down in this README, there is a list of the game's default spawn pools. Spawn pools are stored in `SpawnPools/PoolName.xml`. Note that the example file included has some more comments inside of it that explain what the different parts of the file do. Also note that, further down on this page, there is a list of the game's default spawn pools.
Below is the file for an example spawn pool with some comments that explain the structure in greater detail. To get started making your own spawn pool, it would be easiest to copy this information. Below is the file for an example spawn pool with some comments that explain the structure in greater detail. To get started making your own spawn pool, it would be easiest to copy this information.
```xml ```xml
@ -121,7 +121,7 @@ Below is the file for an example spawn pool with some comments that explain the
<RawPool xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <RawPool xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<!-- These are the entries that this spawn pool has --> <!-- These are the entries that this spawn pool has -->
<Entries> <Entries>
<!-- Each entry contains the name of an item that should be spawned, as well as the weight that item should have. Check the README for information on what the weight value means. --> <!-- Each entry contains the name of an item that should be spawned, as well as the weight that item should have. Scroll down for information on what the weight value means. -->
<RawPoolEntry> <RawPoolEntry>
<Item>Arrow</Item> <Item>Arrow</Item>
<Weight>10</Weight> <Weight>10</Weight>