Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/development/addons/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: lucide/puzzle
---

# Addon Creation

This page outlines a guide to creating your own addons.
Expand Down
4 changes: 4 additions & 0 deletions docs/development/history.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: lucide/book
---

## Early History
---

Expand Down
10 changes: 10 additions & 0 deletions docs/development/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,13 @@ tags:
---

# Development

In this folder you can find various pages around modding, addons and API documentation:

[Addons](/development/addons/index.html)<br>
[API Documentation](/development/api_documentation.html)<br>
[How to Contribute](/development/how_to_contribute.html)<br>
[Modding Guide](/development/modding.html)<br>
[Set up a server](/development/multiplayer.html)<br>
[Permission System](/development/permission_layer.html)<br>
[Development History](/development/history.html)<br>
7 changes: 5 additions & 2 deletions docs/gameplay/game_mechanics.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,18 @@ This page is about the various mechanics that are tied to the player.
The player has 8 hearts (shaped like an anatomical heart), which can be empty, half-full, and full, meaning the player has a total of 16 health. Health can be lost due to fall damage and hazardous blocks such as cacti, lava, or magma. Currently, there is no way to regain health other than dying.

## Energy
The player has 8 energy bars (shaped like a stomach), which can be empty, half-full, and full just like hearts. Currently, there is no way to lose or gain energy, and it does nothing.
The player has 8 energy bars (shaped like a stomach), which can be empty, half-full, and full just like hearts. Currently, this bar does nothing and is purely cosmetic.

## Movement
The player has 3 means of movement, walking, sprinting and crouching.
In survival mode, the player has 3 means of movement, walking, sprinting and crouching.
In creative mode, the player has the same as survival, but with fly, ghost and hyperspeed.

Walking and sprinting are the same, except sprinting is faster. Crouching is the slowest, but prevents you from falling off blocks, unless the block is slippery. You will still be able to step down from smaller blocks, such as a block chiseled into stairs. Crouching also lets you fit into 1.5 block tall spaces.

The player may also jump, providing enough elevation to cross 1 whole block.

Hyperspeed allows the player to go at a really fast speed, way faster than sprinting. Fly allows the player to fly in the air. Ghost also allows the player to fly, but the player can go through blocks. (Kinda like Spectator mode in Minecraft).

While moving mid-air, your directional control is much weaker.

## Inventory and Hotbar
Expand Down
31 changes: 31 additions & 0 deletions setup.cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
@echo off
setlocal
set "SCRIPT=%~nx0"

echo %SCRIPT%: Creating virtual environment...
py -3 -m venv .env || python -m venv .env
if errorlevel 1 (
echo %SCRIPT%: Failed to create virtual environment. Is Python installed and on PATH?
exit /b 1
)

echo %SCRIPT%: Entering virtual env...
call ".env\Scripts\activate.bat"
if errorlevel 1 (
echo %SCRIPT%: Failed to activate virtual environment.
exit /b 1
)

echo %SCRIPT%: Installing wiki dependencies...
pip install -r requirements.txt
if errorlevel 1 (
echo %SCRIPT%: Dependency installation failed.
exit /b 1
)

echo %SCRIPT%: Setup complete
echo.
echo %SCRIPT%: To start the wiki server, run:
echo %SCRIPT%: '.env\Scripts\activate.bat'
echo %SCRIPT%: 'zensical serve'

17 changes: 17 additions & 0 deletions setup.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
$ErrorActionPreference = 'Stop'
$script = $MyInvocation.MyCommand.Name

Write-Host "${script}: Creating virtual environment..."
py -3 -m venv .env

Write-Host "${script}: Entering virtual env..."
. .\.env\Scripts\Activate.ps1

Write-Host "${script}: Installing wiki dependencies..."
pip install -r requirements.txt

Write-Host "${script}: Setup complete`n"
Write-Host "${script}: To start the wiki server, run:"
Write-Host "${script}: '.\.env\Scripts\Activate.ps1'"
Write-Host "${script}: 'zensical serve'"

13 changes: 13 additions & 0 deletions setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
echo "$0: Creating virtual enviroment..."
python3 -m venv .env

echo "$0: Entering virtual env..."
. .env/bin/activate

echo "$0: Installing wiki dependencies..."
pip install -r requirements.txt

echo "$0: Setup complete \n"
echo "$0: To start the wiki server, run:"
echo "$0: 'source .env/bin/activate'"
echo "$0: 'zensical serve '"