Skip to content

Commit 9f361f1

Browse files
committed
Large-scale docs cleanup
1 parent 848dec7 commit 9f361f1

150 files changed

Lines changed: 462 additions & 516 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
1-
# StompyMUX
2-
3-
StompyMUX is a
4-
5-
For more details, see the [StompyMUX Documentation](https://gtaylor.github.io/stompymux/docs/introduction/).
1+
StompyMUX is a game server for creating and hosting text-based multiplayer games about Big Stompy Robots.
2+
It comes with a real-time combat system with AI, a unit repair system, economic building blocks, and much more.
63

74
## Status
85

96
StompyMUX is an occasionally developed modernization fork of [BattletechMUX](https://sourceforge.net/projects/btonline-btech/).
7+
Our foundations are built from more than [three decades of contributions](./docs/content/en/docs/history.md).
8+
While the features in this codebase are very well fleshed out, we may occasionally break things, including backwards compatibility!
9+
10+
## Getting involved
11+
12+
Contributions are welcomed.
13+
See the [Contributing](./docs/content/en/docs/contributing.md) guide.
14+
Visit our [Discord server](https://discord.gg/TJzQByY2nC) to reach the rest of the developer community.
15+
16+
## Support
17+
18+
No support is guaranteed, but you may be able to get help on our [Discord server](https://discord.gg/TJzQByY2nC).
1019

1120
## License
1221

13-
StompyMUX inherits an Artistic License, included in [LICENSE.md](./LICENSE.md).
22+
StompyMUX inherits an Artistic License, included in [LICENSE.md](https://github.com/gtaylor/stompymux/blob/main/LICENSE.md) in the source distribution.

docs/assets/icons/logo.png

362 KB
Loading

docs/assets/icons/logo.svg

Lines changed: 86 additions & 0 deletions
Loading
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: Concepts
33
linkTitle: Concepts
4+
description: Deeper dives on how StompyMUX works
45
type: docs
56
weight: 25
67
---
7-
8-
Background and architecture concepts for BattleTechMUX.

docs/content/en/docs/concepts/btech-architecture.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
title: "BattleTech Architecture"
2+
title: BattleTech Architecture
33
weight: 25
4+
description: An architectural overview of the codebase
45
---
56

6-
# BattleTech architecture
7-
87
BattleTech is a domain-oriented package rooted at `src/btech`. Its public
98
boundary is `src/btech/include/btech`; MUX code must not include any other
109
BattleTech directory.

docs/content/en/docs/concepts/channel-administration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Channel administration
33
linkTitle: Channel administration
4+
description: How to administer in-game communication channels
45
type: docs
56
weight: 30
67
---

docs/content/en/docs/concepts/help-system.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Help system
33
linkTitle: Help system
4+
description: How the in-game help system works
45
type: docs
56
weight: 20
67
---
@@ -24,12 +25,12 @@ starts with a TOML frontmatter block delimited by `+++` lines, followed by
2425
the markdown body:
2526

2627
```markdown
27-
+++
28-
title = "About this game"
29-
description = "All about this game"
30-
keywords = ["about"]
31-
article_tags = ["show_in_index"]
32-
+++
28+
---
29+
title: About this game
30+
description: All about this game
31+
keywords: [about]
32+
article_tags: [show_in_index]
33+
---
3334

3435
# About this game
3536

docs/content/en/docs/concepts/player-account-state.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
+++
2-
title = "Player account state"
3-
description = "How authentication, login history, and page memory are stored"
4-
+++
5-
6-
# Player account state
1+
---
2+
title: Player account state
3+
description: How authentication, login history, and page memory are stored
4+
---
75

86
Player authentication and activity metadata are typed server state rather than
97
object attributes. The SQLite `player_state` table stores password hashes,

docs/content/en/docs/concepts/source-layout.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Source layout
33
linkTitle: Source layout
4+
description: How the codebase is organized
45
type: docs
56
weight: 10
67
---

docs/content/en/docs/concepts/styled-text.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Styled object text
33
linkTitle: Styled text
4+
description: How to style in-game text
45
type: docs
56
weight: 30
67
---

0 commit comments

Comments
 (0)