From 1470a0caf9178879188b063d9bbbbbcb9a49b292 Mon Sep 17 00:00:00 2001 From: Matyas Angyal Date: Sat, 9 Nov 2024 09:01:25 +0100 Subject: [PATCH] docs: rework docs sections --- docs/intro.md | 46 +++++++++++++++++++++++++++++++++++++------- docs/items.md | 4 ++-- docs/leader_stats.md | 4 ++-- docs/play_area.md | 5 +++++ docs/tools.md | 4 ++-- 5 files changed, 50 insertions(+), 13 deletions(-) create mode 100644 docs/play_area.md diff --git a/docs/intro.md b/docs/intro.md index a9d31fc..df65d2c 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -38,13 +38,44 @@ As this project focuses on technical exploration, the emphasis is on continuous development and enhancing the existing codebase. Before getting started, ensure you meet the following requirements listed below. -- Roblox Studio -- Git -- Rojo -- Rojo Plugin -- Luau Language Server -- Node.js -- Moonwave +### Prerequisites + +- [Roblox Studio](https://create.roblox.com/docs/studio/setting-up-roblox-studio) + + Roblox Studio is an all-in-one IDE that lets you create experiences that run on + Roblox. It's free to use and lets you reach millions of users using the Roblox + app on console, desktop, and mobile devices. + +- [Git](https://git-scm.com) + + Git is a free and open source distributed version control system designed to + handle everything from small to very large projects with speed and efficiency. + +- [Rojo](https://rojo.space/docs/v7) + + Rojo is a project management tool designed to get professional resources in + the hands of Roblox developers. + +- [Rojo Plugin](https://rojo.space/docs/v7/getting-started/installation/#installing-the-plugin) + + Once you've installed the Rojo server, you can use it to install or upgrade + the Rojo plugin which will sync changes to Roblox Studio. + +- [Luau Language Server Companion](https://create.roblox.com/store/asset/10913122509/Luau-Language-Server-Companion?externalSource=www) + + Companion plugin to the Luau Language Server ([Luau LSP](https://github.com/JohnnyMorganz/luau-lsp)). This plugin allows the instance + tree to be inferred from Studio, to provide better language features. + +- [Node.js](https://nodejs.org/en) - _(optional to work on the documentation)_ + + Node.js® is a free, open-source, cross-platform JavaScript runtime environment + that lets developers create servers, web apps, command line tools and scripts. + +- [Moonwave](https://eryn.io/moonwave/docs/intro) - _(optional to work on the documentation)_ + + Moonwave is three things: a plugin for [Docusaurus](https://docusaurus.io), a command line tool, and a + parser, which generates JSON from your doc comments, which can also be consumed + by many different tools. ### Rojo Server @@ -52,6 +83,7 @@ Rojo is the core tool for this sandbox, enabling synchronization between the loc codebase and a running Roblox Studio instance. Rojo manages all elements, including models, scripts, and assets like meshes and images. + After checking out the code from source control, open a terminal and run the `make serve` command. This will build the main project file (`default.project.json`) and start the server, which can then be connected to the Rojo plugin in Roblox Studio. diff --git a/docs/items.md b/docs/items.md index 9366468..3b47d7b 100644 --- a/docs/items.md +++ b/docs/items.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- -# Items +# Interactive Environment Items diff --git a/docs/leader_stats.md b/docs/leader_stats.md index d711555..fe5ac36 100644 --- a/docs/leader_stats.md +++ b/docs/leader_stats.md @@ -1,8 +1,8 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- -# Stats +# Statistics & Remote Data ## Usage diff --git a/docs/play_area.md b/docs/play_area.md new file mode 100644 index 0000000..4c4cdf5 --- /dev/null +++ b/docs/play_area.md @@ -0,0 +1,5 @@ +--- +sidebar_position: 2 +--- + +# The Workspace Structure diff --git a/docs/tools.md b/docs/tools.md index e5fb4cc..121735d 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -1,8 +1,8 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- -# Tools +# Player Tools & Equipment Tools are items that can appear in a player's inventory and be equipped to perform specific tasks. For example, an "Axe" tool might be placed in the [StarterPack](https://create.roblox.com/docs/reference/engine/classes/StarterPack) so