summaryrefslogtreecommitdiff
path: root/docs/src/en/guide/getting-started.md
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-01-24 05:01:27 +0900
committerGitHub <noreply@github.com>2026-01-24 05:01:27 +0900
commite3387a401c6d0d094b3afa734558e9257465a42b (patch)
tree4202c404fc72249f117162a37a573bcec274d555 /docs/src/en/guide/getting-started.md
parentac80dc3ce71f9be0397442208cac80f6069eea03 (diff)
parentf6b0baf90c20a1d3b0cd53629102883b4bd913c6 (diff)
downloadLunaticChat-0.5.0.tar.gz
LunaticChat-0.5.0.tar.bz2
LunaticChat-0.5.0.zip
Merge pull request #65 from m1sk9/chore/release-beta-stagev0.5.0
chore: Release to beta stage
Diffstat (limited to 'docs/src/en/guide/getting-started.md')
-rw-r--r--docs/src/en/guide/getting-started.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/src/en/guide/getting-started.md b/docs/src/en/guide/getting-started.md
new file mode 100644
index 0000000..1fd9f0d
--- /dev/null
+++ b/docs/src/en/guide/getting-started.md
@@ -0,0 +1,29 @@
+# Getting Started
+
+## Installation
+
+Install LunaticChat. LunaticChat can be obtained from:
+
+- [GitHub](https://github.com/m1sk9/LunaticChat/releases)
+- [Modrinth](https://modrinth.com/project/lunaticchat)
+
+Place the downloaded plugin file in your server's `plugins` folder and restart the server.
+
+## Configuration
+
+When LunaticChat starts, the following files will be created:
+
+- `plugins/LunaticChat/config.yml`: Plugin configuration file
+- `plugins/LunaticChat/player-settings.yaml`: User-specific settings file
+- `plugins/LunaticChat/conversion_cache.json`: Romanization conversion cache file
+
+Open the configuration file `config.yml` and modify the settings as needed. For details on configuration options, refer to the [Configuration Guide](admin/configuration.md).
+
+## Permissions
+
+Set LunaticChat's permissions using a permission management plugin like LuckPerms.
+
+Basic permissions can be configured using Paper or Velocity's default permission system (`OP` / `non OP`), but LuckPerms is recommended for more detailed control.
+
+- For details on permission nodes, refer to the [Permissions Guide](../reference/permissions.md).
+- For permission nodes corresponding to each command feature, refer to the [Command Reference](../reference/index.md).