Skip to content

Commit 92c5101

Browse files
Stampede2011Stampede2011
committed
Added docs for CobbleDollars Bridge mod
1 parent 17a9fcb commit 92c5101

6 files changed

Lines changed: 164 additions & 0 deletions

File tree

‎astro.config.mjs‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,26 @@ export default defineConfig({
199199
}
200200
],
201201
},
202+
{
203+
label: 'CobbleDollars Bridge',
204+
link: '/cobbledollarsbridge/getting_started/introduction',
205+
icon: 'open-book',
206+
items: [
207+
{
208+
label: "Getting Started",
209+
items: [
210+
'cobbledollarsbridge/getting_started/introduction',
211+
'cobbledollarsbridge/getting_started/installation'
212+
]
213+
},
214+
{
215+
label: "Main Config",
216+
items: [
217+
'cobbledollarsbridge/config/config'
218+
]
219+
},
220+
],
221+
},
202222
]),
203223
],
204224
components: {

‎src/content/docs/cobbledollarsbridge/config/config.mdx‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: Mod Configuration
3+
description: Guide to configure the Main Config for the CobbleDollars Bridge mod
4+
---
5+
6+
import { FileTree } from '@astrojs/starlight/components';
7+
import { Code } from '@astrojs/starlight/components';
8+
import { LinkCard } from '@astrojs/starlight/components';
9+
import defaultConfig from './default_config.json?raw';
10+
11+
The guide explains configuring the main `config.json` file for CobbleDollars Bridge. The main configuration file contains global settings that affect the entire mod.
12+
13+
<FileTree>
14+
- config
15+
- cobbledollarsbridge
16+
- config.json
17+
</FileTree>
18+
19+
***
20+
## Example File
21+
<Code code={defaultConfig} lang="json" title="config.json" />
22+
23+
## Options
24+
***
25+
### Key
26+
Define the ID that will be registered for the CobbleDollars currency in Impactor.
27+
```json
28+
"key": {
29+
"namespace": "impactor",
30+
"value": "cobbledollars"
31+
}
32+
```
33+
### Name
34+
Set the display name for the CobbleDollars currency, singular form.
35+
```json
36+
"name": "CobbleDollar"
37+
```
38+
### Plural
39+
Set the plural display name for the CobbleDollars currency.
40+
```json
41+
"plural": "CobbleDollars"
42+
```
43+
### Symbol
44+
Set the symbol used to represent CobbleDollars.
45+
```json
46+
"symbol": "€"
47+
```
48+
### Formatting
49+
Define the formatting pattern for displaying CobbleDollars amounts. Valid placeholders: `<symbol>`, `<amount>`, `<name>`
50+
```json
51+
"formatting": {
52+
"condensed": "<symbol><amount>",
53+
"expanded": "<amount> <name>"
54+
}
55+
```
56+
#### Condensed
57+
Format used for compact displays of CobbleDollars amounts.
58+
```json
59+
"condensed": "<symbol><amount>"
60+
```
61+
#### Expanded
62+
Format used for detailed displays of CobbleDollars amounts.
63+
```json
64+
"expanded": "<amount> <name>"
65+
```
66+
### Transferable
67+
Enable or disable the ability for players to pay CobbleDollars between each other through Impactor.
68+
```json
69+
"transferable": true
70+
```

‎src/content/docs/cobbledollarsbridge/config/default_config.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"key": {
3+
"namespace": "impactor",
4+
"value": "cobbledollars"
5+
},
6+
"name": "CobbleDollar",
7+
"plural": "CobbleDollars",
8+
"symbol": "€",
9+
"formatting": {
10+
"condensed": "<symbol><amount>",
11+
"expanded": "<amount> <name>"
12+
},
13+
"transferable": true
14+
}

‎src/content/docs/cobbledollarsbridge/getting_started/installation.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Installation
3+
description: Installing the CobbleDollars Bridge mod
4+
---
5+
6+
Installing the CobbleDollars Bridge mod is as straightforward as almost any mod! Follow the steps below to get started.
7+
8+
:::note
9+
CobbleDollars Bridge can be installed in either a server or client environment as long as the requirements are met!
10+
:::
11+
12+
***
13+
## Server Requirements
14+
CobbleDollars Bridge requires the following to run (as of January 2026):
15+
- **Minecraft** - 1.21.1
16+
- **Fabric Loader** - 0.17.2+
17+
- **Fabric API** - 0.116.6-1.21.1 (or greater)
18+
- **Java** - 21+
19+
- **Fabric Language Kotlin** - 1.13.0+kotlin.2.1.0 (or greater)
20+
- **CobbleDollars** - v5.0.0+BETA-5.1 (or greater)
21+
- **Impactor** - 5.3.0+
22+
23+
## Installation Steps
24+
1. Set up a Fabric server with Minecraft 1.21.1
25+
2. Install the CobbleDollars Bridge mod jar into the `mods` folder of your server. Download the mod <a href="https://modrinth.com/mod/cobbledollars-bridge" target="_blank" rel="noopener noreferrer">here</a>!
26+
3. Download all required dependencies for the mod (See [Server Requirements](#server-requirements) above)]
27+
4. Restart the server to generate the configuration files and folders.
28+
5. Modify and access your balance using Impactor's `/eco` commands
29+
6. Configure mod options in the `config.json` file inside the `config/cobbledollarsbridge/` folder. See the [Mod Configuration](/cobbledollarsbridge/config/) guide for more information.

‎src/content/docs/cobbledollarsbridge/getting_started/introduction.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Introduction
3+
description: Documentation for the CobbleDollars Bridge mod
4+
---
5+
6+
Welcome to the documentation for the CobbleDollars Bridge mod! This guide will help you get started with using and configuring the mod.
7+
***
8+
9+
## Quick Start
10+
1. Install the CobbleDollars Bridge mod jar onto your server. Download the mod <a href="https://modrinth.com/mod/cobbledollars-bridge" target="_blank" rel="noopener noreferrer">here</a>!
11+
2. Modify and access your balance using Impactor's `/eco` commands
12+
13+
## What is CobbleDollars Bridge?
14+
15+
CobbleDollars Bridge is a server-sided fabric mod that allows you to modify and access player CobbleDollars accounts through Impactor. This allows 3rd party mods that support Impactor to also support CobbleDollars.
16+
17+
## Getting Started
18+
1. [Introduction](/cobbledollarsbridge/getting_started/introduction/)
19+
<br>Initial introduction to the CobbleDollars Bridge mod, understanding the purpose and features of the mod.
20+
2. [Installation](/cobbledollarsbridge/getting_started/installation/)
21+
<br>Guide to install the CobbleDollars Bridge mod, dependencies, and optional integrations.
22+
23+
## Configuration
24+
1. [Main Configuration](/cobbledollarsbridge/config/config/)
25+
<br>Guide to configure the main `config.json` file for CobbleDollars Bridge. These settings apply globally to the mod.

‎src/content/docs/index.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
3939
💾 Available for free on <a href="https://modrinth.com/project/actionitems/" target="_blank" rel="noopener noreferrer">Modrinth</a>.<br />
4040
📖 Documentation available [here](/actionitems/getting_started/introduction/)
4141
</Card>
42+
<Card title="CobbleDollars Bridge" icon="open-book">
43+
Server-sided bridge between CobbleDollars and Impactor for Fabric servers
44+
45+
💾 Available for free on <a href="https://modrinth.com/project/cobbledollars-bridge/" target="_blank" rel="noopener noreferrer">Modrinth</a>.<br />
46+
📖 Documentation available [here](/cobbledollarsbridge/getting_started/introduction/)
47+
</Card>
4248
<Card title="SkiesKits" icon="add-document">
4349
Server-sided customizable Kits for Fabric servers
4450

0 commit comments

Comments
 (0)