Skip to content

Commit

Permalink
docs: rework docs sections
Browse files Browse the repository at this point in the history
  • Loading branch information
matyasjay committed Nov 9, 2024
1 parent 9a4d8a3 commit 1470a0c
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 13 deletions.
46 changes: 39 additions & 7 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,52 @@ 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

Rojo is the core tool for this sandbox, enabling synchronization between the local
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.
Expand Down
4 changes: 2 additions & 2 deletions docs/items.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
---

# Items
# Interactive Environment Items
4 changes: 2 additions & 2 deletions docs/leader_stats.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 4
sidebar_position: 5
---

# Stats
# Statistics & Remote Data

## Usage

Expand Down
5 changes: 5 additions & 0 deletions docs/play_area.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# The Workspace Structure
4 changes: 2 additions & 2 deletions docs/tools.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 1470a0c

Please sign in to comment.