xerbalind/planetwars.dev
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages 1 Wiki Activity

translate rules view to markdown

Browse source
This commit is contained in:
Ilion Beyst 2022-09-05 19:21:37 +02:00
parent dcb0a2bde8
commit d68731a114
4 changed files with 85 additions and 141 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

124
web/pw-server/src/lib/components/RulesView.svelte
View file

@ -1,124 +0,0 @@
<div class="container">
<div class="game-rules">
<h2 class="title">How to play</h2>
<p>
In every game turn, your bot will receive a json-encoded line on stdin, describing the current
state of the game. Each state will hold a set of planets, and a set of spaceship fleets
traveling between the planets (<em>expeditions</em>).
</p>
<p>Example game state:</p>
<pre>{`
{
"planets": [
{
"ship_count": 2,
"x": -2.0,
"y": 0.0,
"owner": 1,
"name": "your planet"
},
{
"ship_count": 4,
"x": 2.0,
"y": 0.0,
"owner": 2,
"name": "enemy planet"
},
{
"ship_count": 2,
"x": 0.0,
"y": 2.0,
"owner": null,
"name": "neutral planet"
}
],
"expeditions": [
{
"id": 169,
"ship_count": 8,
"origin": "your planet",
"destination": "enemy planet",
"owner": 1,
"turns_remaining": 2
}
]
}
`}</pre>
<p>
The <code>owner</code> field holds a player number when the planet is held by a player, and is
<code>null</code> otherwise. Your bot is always referred to as player 1.<br />
Each turn, every player-owned planet will gain one additional ship. <br />
Planets will never move during the game.
</p>
<p>
Every turn, you may send out expeditions to conquer other planets. You can do this by writing
a json-encoded line to stdout:
</p>
<p>Example command:</p>
<pre>{`
{
"moves": [
{
"origin": "your planet",
"destination": "enemy planet",
"ship_count": 2
}
]
}
`}
</pre>
<p>
All players send out their commands simultaneously, so there is no turn order. You may send as
many commands as you please.
</p>
<p>
The amount of turns an expedition will travel is equal to the ceiled euclidean distance
between its origin and destination planet.
</p>
<p>
Ships will only battle on planets. Combat resolution is simple: every ship destroys one enemy
ship, last man standing gets to keep the planet.
</p>
<p>
The game will end when no enemy player ships remain (neutral ships may survive), or when the
turn limit is reached. The default limit is 100 turns.
</p>
<p>
You can code your bot in python 3.10. You have the entire stdlib at your disposal. <br />
If you'd like additional libraries or a different programming language, feel free to nag the administrator.
</p>
<h3 class="tldr">TL;DR</h3>
<p>
Head over to the editor view to get started - a working example is provided. <br />
Feel free to just hit the play button to see how it works!
</p>
</div>
</div>
<style lang="scss">
.container {
overflow-y: scroll;
height: 100%;
box-sizing: border-box;
}
.game-rules {
padding: 15px 30px;
max-width: 800px;
}
.game-rules p {
padding-top: 1.5em;
}
.game-rules .tldr {
padding-top: 3em;
}
</style>

2
web/pw-server/src/routes/__layout.svelte
View file

@ -17,7 +17,7 @@
<a href="/leaderboard">Leaderboard</a> <a href="/leaderboard">Leaderboard</a>
</div> </div>
<div class="navbar-item"> <div class="navbar-item">
<a href="/docs">How to play</a> <a href="/docs/rules">How to play</a>
</div> </div>
</div> </div>
<div class="navbar-right"> <div class="navbar-right">

14
web/pw-server/src/routes/docs.svelte
View file

@ -1,14 +0,0 @@
<script>
import RulesView from "$lib/components/RulesView.svelte";
</script>
<div class="container">
<RulesView />
</div>
<style scoped lang="scss">
.container {
max-width: 800px;
margin: 0 auto;
}
</style>

86
web/pw-server/src/routes/docs/rules.md
View file

@ -1,3 +1,85 @@
# Rules
Hello welcome on the rules page ## How to play
In every game turn, your bot will receive a json-encoded line on stdin, describing the current
state of the game. Each state will hold a set of planets, and a set of spaceship fleets
traveling between the planets (_expeditions_).
Example game state:
```json
{
"planets": [
{
"ship_count": 2,
"x": -2.0,
"y": 0.0,
"owner": 1,
"name": "your planet"
},
{
"ship_count": 4,
"x": 2.0,
"y": 0.0,
"owner": 2,
"name": "enemy planet"
},
{
"ship_count": 2,
"x": 0.0,
"y": 2.0,
"owner": null,
"name": "neutral planet"
}
],
"expeditions": [
{
"id": 169,
"ship_count": 8,
"origin": "your planet",
"destination": "enemy planet",
"owner": 1,
"turns_remaining": 2
}
]
}
```
The `owner` field holds a player number when the planet is held by a player, and is
`null` otherwise. Your bot is always referred to as player 1.
Each turn, every player-owned planet will gain one additional ship.
Planets will never move during the game.
Every turn, you may send out expeditions to conquer other planets. You can do this by writing
a json-encoded line to stdout:
Example command:
```json
{
"moves": [
{
"origin": "your planet",
"destination": "enemy planet",
"ship_count": 2
}
]
}
```
All players send out their commands simultaneously, so there is no turn order. You may send as
many commands as you please.
The amount of turns an expedition will travel is equal to the ceiled euclidean distance
between its origin and destination planet.
Ships will only battle on planets. Combat resolution is simple: every ship destroys one enemy
ship, last man standing gets to keep the planet.
The game will end when no enemy player ships remain (neutral ships may survive), or when the
turn limit is reached. The default limit is 100 turns.
You can code your bot in python 3.10. You have the entire stdlib at your disposal.
If you'd like additional libraries or a different programming language, feel free to nag the administrator.
### TL;DR
Head over to the editor view to get started - a working example is provided.
Feel free to just hit the play button to see how it works!