From 8cf5ca7ff0fb2d6ddf6ee1557ebfa49067bec1d3 Mon Sep 17 00:00:00 2001 From: suprohub Date: Mon, 30 Dec 2024 12:36:34 +0400 Subject: [PATCH 1/7] Fix docs --- docs/config/basic.md | 158 +++++++++++++++++++++++++++---------------- 1 file changed, 100 insertions(+), 58 deletions(-) diff --git a/docs/config/basic.md b/docs/config/basic.md index 1703b11..7c58029 100644 --- a/docs/config/basic.md +++ b/docs/config/basic.md @@ -4,51 +4,64 @@ Representing `configuration.toml` ## Server Address -The address to bind the server to +The address to bind the server to. -```toml -server_address=0.0.0.0 +:::code-group +```toml [configuration.toml] {2} +server_address = "0.0.0.0:25565" ``` +::: ## Seed -The seed for world generation +The seed for world generation. -```toml -seed= +:::code-group +```toml [configuration.toml] {2} +seed = "" ``` +::: ## Max players -The maximum number of players allowed on the server +The maximum number of players allowed on the server. -```toml -max_players=10000 +:::code-group +```toml [configuration.toml] {2} +max_players = 100000 ``` +::: ## View distance -The maximum view distance for players +The maximum view distance for players. -```toml -view_distance=10 +:::code-group +```toml [configuration.toml] {2} +view_distance = 10 ``` +::: ## Simulation distance -The maximum simulation distance for players +The maximum simulation distance for players. -```toml -simulation_distance=10 +:::code-group +```toml [configuration.toml] {2} +simulation_distance = 10 ``` +::: ## Default difficulty -The default game difficulty +The default game difficulty. -```toml -default_difficulty=Normal +:::code-group +```toml [configuration.toml] {2} +default_difficulty = "Normal" ``` +::: + ```toml Peaceful @@ -57,81 +70,88 @@ Normal Hard ``` +## Operation permission level + +The default permission level for all players. + +:::code-group +```toml [configuration.toml] {2} +op_permission_level = 4 +``` +::: + ## Allow nether -Whether the Nether dimension is enabled +Whether the Nether dimension is enabled. -```toml -allow_nether=true +:::code-group +```toml [configuration.toml] {2} +allow_nether = true ``` +::: ## Hardcore Whether the server is in hardcore mode. -```toml -hardcore=true +:::code-group +```toml [configuration.toml] {2} +hardcore = false ``` +::: ## Online Mode -Whether online mode is enabled. Requires valid Minecraft accounts +Whether online mode is enabled. Requires valid Minecraft accounts. -```toml -online_mode=true +:::code-group +```toml [configuration.toml] {2} +online_mode = true ``` +::: ## Encryption -Whether packet encryption is enabled +Whether packet encryption is enabled. > [!IMPORTANT] -> Required when online mode is enabled +> Required when online mode is enabled. -```toml -encryption=true +:::code-group +```toml [configuration.toml] {2} +encryption = true ``` +::: ## Motd The server's description displayed on the status screen. -```toml -motd=true +:::code-group +```toml [configuration.toml] {2} +motd = "A Blazing fast Pumpkin Server!" ``` +::: ## TPS -The server's Tick rate. - -```toml -tps=20.0 -``` - - -## Use favicon - -Whether to use a server favicon or not +The target server's Tick rate. -```toml -use_favicon=true -``` - -## Favicon path - -The path to the server's favicon - -```toml -favicon_path=./icon.png +:::code-group +```toml [configuration.toml] {2} +tps = 20.0 ``` +::: ## Default gamemode -The default game mode for players +The default game mode for players. -```toml -default_gamemode=Survival +:::code-group +```toml [configuration.toml] {2} +default_gamemode = "Survival" ``` +::: ```toml Undefined @@ -143,8 +163,30 @@ Spectator ## IP Scrubbing -Whether to scrub player IPs from logs +Whether to scrub player IPs from logs. -```toml -scrub_ips=true +:::code-group +```toml [configuration.toml] {2} +scrub_ips = true +``` +::: + +## Use favicon + +Whether to use a server favicon or not. + +:::code-group +```toml [configuration.toml] {2} +use_favicon = true +``` +::: + +## Favicon path + +The path to the server's favicon. + +:::code-group +```toml [configuration.toml] {2} +favicon_path = "icon.png" ``` +::: \ No newline at end of file From 6cef4abec8674466787bdeba07bc53176a29d4c5 Mon Sep 17 00:00:00 2001 From: Suprohub Date: Fri, 24 Jan 2025 21:01:59 +0400 Subject: [PATCH 2/7] Android dev page --- docs/.vitepress/config.mts | 1 + docs/developer/android.md | 66 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 docs/developer/android.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index b6923db..3926590 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -57,6 +57,7 @@ export default defineConfig({ ] }, { text: "World", link: "developer/world" }, + { text: "Android dev", link: "developer/android" }, ], }, { diff --git a/docs/developer/android.md b/docs/developer/android.md new file mode 100644 index 0000000..208c7c3 --- /dev/null +++ b/docs/developer/android.md @@ -0,0 +1,66 @@ +# Android pumpkin developing + +If you are android user and want edit source code - you can do this! +(this page was written on android using helix) + +First of all we need terminal app. +We recommend [termux](https://github.com/termux/termux-app/releases), because its stable and opensource.i +Download needed apk file for your architecture of device and install termux. + +After this, you need run some commands. We use helix with it simplicity. +```bash + pkg update && pkg upgrade + pkg install build-essential git rust rust-analyzer taplo helix helix-grammar nodejs +``` + +If you want contribute, you need install github. +```bash + pkg install gh +``` + +Also we recommend install fish shell, because its more friendly that bash. +```bash + pkg install fish + chsh -s fish +``` + +Now you installed basic tools, but we need some setup. +If you want contribute you need login into github. +```bash + gh auth login +``` + +Also setup git: change editor to vim, edit credentials and etc. + +After this, you need clone pumpkin repo. (before this you can create projects dir with `mkdir proj`, its useful) +```bash + git clone https://github.com/Pumpkin-MC/Pumpkin.git +``` + +If you want contribute, you need fork our repo, and change `Pumpkin-MC` to your username on github. + +Now all setup done! Enjoy :) + +# FAQ + +## How use editor? +Type `hx `. + +## How navigate over project? +You can use `ls`, `cd` and other programs. +You can also use `hx ` for locate over dir when start. + +## How i can type in editor? +Press `i` if you in normal mode. + +## HOW EXIT FROM EDITOR???? +Press esc, when type `:q!`` if you dont want save edited data, or `:wq` if want. + +## Where i can learn how use this editor? +Type `hx --tutor` or go to offical website. + +## Why not use vscode? +1) Vscode is hard to setup, by the way its works only on web with limited functional. +2) Rust analyzer dont work on it, maybe emulator can hep with it, but its slow down code compilation. +3) Vscode not good for android devices, because its higly desirable to have a mouse, while in helix you need only keyboard. +4) Vscode laggy on some devices. From b583ec8de180d500744f1676608e0c73ca7259f2 Mon Sep 17 00:00:00 2001 From: Suprohub Date: Fri, 24 Jan 2025 21:05:03 +0400 Subject: [PATCH 3/7] Keyboard --- docs/developer/android.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/developer/android.md b/docs/developer/android.md index 208c7c3..5762992 100644 --- a/docs/developer/android.md +++ b/docs/developer/android.md @@ -64,3 +64,6 @@ Type `hx --tutor` or go to offical website. 2) Rust analyzer dont work on it, maybe emulator can hep with it, but its slow down code compilation. 3) Vscode not good for android devices, because its higly desirable to have a mouse, while in helix you need only keyboard. 4) Vscode laggy on some devices. + +## Why its so hard to type? +Buy cheap bluetooth keyboard and see how it simple. From a7135222b0617d2c9efd96a62d438f92bec34b0f Mon Sep 17 00:00:00 2001 From: suprohub <125716028+suprohub@users.noreply.github.com> Date: Sun, 26 Jan 2025 18:14:19 +0400 Subject: [PATCH 4/7] Remove `i` --- docs/developer/android.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/android.md b/docs/developer/android.md index 5762992..0cae34b 100644 --- a/docs/developer/android.md +++ b/docs/developer/android.md @@ -4,7 +4,7 @@ If you are android user and want edit source code - you can do this! (this page was written on android using helix) First of all we need terminal app. -We recommend [termux](https://github.com/termux/termux-app/releases), because its stable and opensource.i +We recommend [termux](https://github.com/termux/termux-app/releases), because its stable and opensource. Download needed apk file for your architecture of device and install termux. After this, you need run some commands. We use helix with it simplicity. From 307ab36baf4d26a520981409185f38546b5acd20 Mon Sep 17 00:00:00 2001 From: suprohub <125716028+suprohub@users.noreply.github.com> Date: Sat, 1 Feb 2025 21:54:39 +0400 Subject: [PATCH 5/7] Update config.mts --- docs/.vitepress/config.mts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 8907f18..a74f6b0 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -57,7 +57,7 @@ export default defineConfig({ ] }, { text: "World", link: "developer/world" }, - { text: "Android dev", link: "developer/android" }, + { text: "Mobile dev", link: "developer/android" }, ], }, { From 4ad8f0b39827bd2b13edc335963e4dd36b94f665 Mon Sep 17 00:00:00 2001 From: suprohub <125716028+suprohub@users.noreply.github.com> Date: Sat, 1 Feb 2025 21:55:09 +0400 Subject: [PATCH 6/7] Update config.mts x2 --- docs/.vitepress/config.mts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index a74f6b0..0a9a30b 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -57,7 +57,7 @@ export default defineConfig({ ] }, { text: "World", link: "developer/world" }, - { text: "Mobile dev", link: "developer/android" }, + { text: "Mobile dev", link: "developer/mobile" }, ], }, { From 18782912609afcf12660197e947d6e3836a67f30 Mon Sep 17 00:00:00 2001 From: suprohub <125716028+suprohub@users.noreply.github.com> Date: Sat, 1 Feb 2025 21:56:56 +0400 Subject: [PATCH 7/7] Update and rename android.md to mobile.md --- docs/developer/{android.md => mobile.md} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename docs/developer/{android.md => mobile.md} (95%) diff --git a/docs/developer/android.md b/docs/developer/mobile.md similarity index 95% rename from docs/developer/android.md rename to docs/developer/mobile.md index 0cae34b..e4d5491 100644 --- a/docs/developer/android.md +++ b/docs/developer/mobile.md @@ -1,6 +1,6 @@ -# Android pumpkin developing +# Mobile pumpkin developing -If you are android user and want edit source code - you can do this! +If you are mobile user and want edit source code - you can do this! (this page was written on android using helix) First of all we need terminal app.