mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-04-22 21:55:15 +00:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d147ae7bb6 | ||
|
|
9b6ce57c79 | ||
|
|
ed85d2a327 | ||
|
|
7e5b8cadfc | ||
|
|
c805f4fa2d | ||
|
|
f09d7fb0ff | ||
|
|
4e918bab5e | ||
|
|
8e3f9b3bfd |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1 +1,2 @@
|
|||||||
/site
|
/site
|
||||||
|
/generate-docs
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ If your project is in the right place, Rojo will let you know that it was found
|
|||||||
|
|
||||||
In Roblox Studio, open the plugins tab and find Rojo's buttons.
|
In Roblox Studio, open the plugins tab and find Rojo's buttons.
|
||||||
|
|
||||||

|

|
||||||
{: align="center" }
|
{: align="center" }
|
||||||
|
|
||||||
Press **Test Connection** to verify that the plugin can communicate with the dev server. Watch the Output panel for the results.
|
Press **Test Connection** to verify that the plugin can communicate with the dev server. Watch the Output panel for the results.
|
||||||
@@ -64,7 +64,7 @@ Press **Test Connection** to verify that the plugin can communicate with the dev
|
|||||||
!!! info
|
!!! info
|
||||||
If you see an error message, return to the previous steps and make sure that the Rojo dev server is running.
|
If you see an error message, return to the previous steps and make sure that the Rojo dev server is running.
|
||||||
|
|
||||||

|

|
||||||
{: align="center" }
|
{: align="center" }
|
||||||
|
|
||||||
After your connection was successful, press **Sync In** to move code from the filesystem into Studio, or use **Toggle Polling** to have Rojo automatically sync in changes as they happen.
|
After your connection was successful, press **Sync In** to move code from the filesystem into Studio, or use **Toggle Polling** to have Rojo automatically sync in changes as they happen.
|
||||||
|
|||||||
@@ -1,6 +1,16 @@
|
|||||||
# Home
|
This is the documentation home for **Rojo 0.4.x**.
|
||||||
This is the documentation home for Rojo.
|
|
||||||
|
|
||||||
**Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
|
!!! warning
|
||||||
|
Rojo 0.4.x has reached end-of-life as of the release of Rojo 0.5.0 on August 27, 2019.
|
||||||
|
|
||||||
This documentation is a work in progress, and is incomplete.
|
Upgrading to Rojo 0.5.0 is strongly recommended to get new features and continue getting support.
|
||||||
|
|
||||||
|
Available versions of these docs:
|
||||||
|
|
||||||
|
* [Latest version from `master` branch](https://rojo.space/docs/latest)
|
||||||
|
* [0.5.x](https://rojo.space/docs/0.5.x)
|
||||||
|
* [0.4.x](https://rojo.space/docs/0.4.x)
|
||||||
|
|
||||||
|
**Rojo** is a tool designed to enable Roblox developers to use professional-grade software engineering tools.
|
||||||
|
|
||||||
|
This documentation is a continual work in progress. If you find any issues, please file an issue on [Rojo's issue tracker](https://github.com/rojo-rbx/rojo/issues)!
|
||||||
@@ -5,7 +5,7 @@ This page aims to describe how Rojo turns files on the filesystem into Roblox ob
|
|||||||
Any directory on the filesystem will turn into a `Folder` instance in Roblox, unless that folder matches the name of a service or other existing instance. In those cases, that instance will be preserved.
|
Any directory on the filesystem will turn into a `Folder` instance in Roblox, unless that folder matches the name of a service or other existing instance. In those cases, that instance will be preserved.
|
||||||
|
|
||||||
## Scripts
|
## Scripts
|
||||||
Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The default script type is `ModuleScript`, since most scripts in well-structued Roblox projects will be modules.
|
Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The default script type is `ModuleScript`, since most scripts in well-structured Roblox projects will be modules.
|
||||||
|
|
||||||
| File Name | Instance Type |
|
| File Name | Instance Type |
|
||||||
| -------------- | -------------- |
|
| -------------- | -------------- |
|
||||||
@@ -13,7 +13,7 @@ Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The defa
|
|||||||
| `*.client.lua` | `LocalScript` |
|
| `*.client.lua` | `LocalScript` |
|
||||||
| `*.lua` | `ModuleScript` |
|
| `*.lua` | `ModuleScript` |
|
||||||
|
|
||||||
If a directory contains a file named `init.server.lua`, `init.client.lua`, or `init.lua`, that folder will be transformed into a `*Script` instance with the conents of the `init` file. This can be used to create scripts inside of scripts.
|
If a directory contains a file named `init.server.lua`, `init.client.lua`, or `init.lua`, that folder will be transformed into a `*Script` instance with the contents of the `init` file. This can be used to create scripts inside of scripts.
|
||||||
|
|
||||||
For example, this file tree:
|
For example, this file tree:
|
||||||
|
|
||||||
@@ -23,7 +23,7 @@ For example, this file tree:
|
|||||||
|
|
||||||
Will turn into these instances in Roblox:
|
Will turn into these instances in Roblox:
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Models
|
## Models
|
||||||
Rojo supports a JSON model format for representing simple models. It's designed for instance types like `BindableEvent` or `Value` objects, and is not suitable for larger models.
|
Rojo supports a JSON model format for representing simple models. It's designed for instance types like `BindableEvent` or `Value` objects, and is not suitable for larger models.
|
||||||
@@ -62,4 +62,4 @@ JSON model files are fairly strict; any syntax errors will cause the model to fa
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
site_name: Rojo Documentation
|
site_name: Rojo Documentation
|
||||||
site_url: https://lpghatguy.github.io/rojo/
|
site_url: https://lpghatguy.github.io/rojo/0.4.x
|
||||||
repo_name: LPGhatguy/rojo
|
repo_name: LPGhatguy/rojo
|
||||||
repo_url: https://github.com/LPGhatguy/rojo
|
repo_url: https://github.com/LPGhatguy/rojo
|
||||||
|
|
||||||
@@ -9,7 +9,7 @@ theme:
|
|||||||
primary: 'Red'
|
primary: 'Red'
|
||||||
accent: 'Red'
|
accent: 'Red'
|
||||||
|
|
||||||
pages:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Why Rojo?: why-rojo.md
|
- Why Rojo?: why-rojo.md
|
||||||
- Getting Started:
|
- Getting Started:
|
||||||
|
|||||||
Reference in New Issue
Block a user