-
-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add initial moonwave documentation
- Loading branch information
Showing
643 changed files
with
10,943 additions
and
3,392 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
name: Docs | ||
on: | ||
push: | ||
branches: | ||
- main | ||
jobs: | ||
build: | ||
name: Build and deploy docs | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-node@v2 | ||
with: | ||
node-version: "14" | ||
- run: npm i -g moonwave@latest | ||
- name: Publish | ||
run: | | ||
git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git | ||
git config --global user.email "support+actions@github.com" | ||
git config --global user.name "github-actions-bot" | ||
moonwave build --publish | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,5 @@ | |
node_modules | ||
out | ||
roblox.toml | ||
.env | ||
.env | ||
build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# What is Nevermore? | ||
|
||
Nevermore is a ModuleScript loader for Roblox, and loads modules by name. Nevermore is designed to make code more portable. Nevermore comes with a variety of utility libraries. These libraries are used on both the client and server and are useful for a variety of things. These libraries are separated into packages that can be consumed individually using npm. | ||
|
||
Nevermore follows both functional and OOP programming paradigms. However, many modules return classes, and may require more advance Lua knowledge to use. | ||
|
||
# Getting Started with Nevermore | ||
|
||
Getting started with Nevermore is not easy. | ||
|
||
## Installing Nevermore | ||
|
||
1. Install foreman | ||
2. Install npm | ||
|
||
## Install using npm | ||
Nevermore is designed to use [npm](https://www.npmjs.com/) to manage packages. You can install a package like this. | ||
|
||
``` | ||
npm install @quenty/maid | ||
``` | ||
|
||
Each package is designed to be synced into Roblox using [rojo](https://rojo.space/). | ||
|
||
:::warning | ||
Right now you need a special version of Rojo to sync in the npm dependencies properly! | ||
::: |
7 changes: 4 additions & 3 deletions
7
games/integration/modules/Client/Button/LookAtButtonsClient.lua
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
games/integration/modules/Shared/Button/PhysicalButtonConstants.lua
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,188 @@ | ||
title = "Nevermore" | ||
gitRepoUrl = "https://github.com/Quenty/NevermoreEngine" | ||
|
||
gitSourceBranch = "main" | ||
changelog = true | ||
|
||
organizationName = "Quenty" | ||
projectName = "Nevermore" | ||
url = "https://quenty.github.io" | ||
baseUrl = "/NevermoreEngine/" | ||
tagline = "Quenty's reusable code for Roblox" | ||
|
||
[[navbar.items]] | ||
href = "https://discord.gg/mhtGUS8" | ||
label = "Discord" | ||
position = "right" | ||
|
||
[footer] | ||
style = "dark" | ||
copyright = "Copyright © 2014-2021 James Onnen." | ||
|
||
[docusaurus] | ||
url = "https://quenty.github.io" | ||
baseUrl = "/NevermoreEngine/" | ||
|
||
[home] | ||
enabled = true | ||
includeReadme = true | ||
|
||
[[home.features]] | ||
title = "Faster development" | ||
description = "Speed up Roblox development With Nevermore. With built in IK, Ragdoll, camera systems, and more, development has never been faster." | ||
|
||
[[home.features]] | ||
title = "Composable" | ||
description = "Libraries are modular! Modules are designed to compose both with Roblox and each other." | ||
|
||
[[home.features]] | ||
title = "Battle tested" | ||
description = "These libraries are old, and have been used in production for millions of game sessions" | ||
|
||
[[classOrder]] | ||
section = "Octree" | ||
classes = [ | ||
"Octree", | ||
"OctreeNode", | ||
"OctreeRegionUtils" | ||
] | ||
|
||
[[classOrder]] | ||
section = "Rx" | ||
classes = ["Rx", "Observable", "Subscription"] | ||
|
||
[[classOrder]] | ||
section = "DataStore" | ||
classes = [ | ||
"DataStore", | ||
"PlayerDataStoreManager", | ||
"DataStorePromises", | ||
"DataStoreWriter", | ||
"DataStoreStage", | ||
"DataStoreDeleteToken" | ||
] | ||
|
||
[[classOrder]] | ||
section = "Promise" | ||
classes = ["Promise", "PromiseUtils", "PendingPromiseTracker", "promiseChild"] | ||
|
||
[[classOrder]] | ||
section = "Signal" | ||
classes = ["Signal", "SignalUtils"] | ||
|
||
[[classOrder]] | ||
section = "Binder" | ||
classes = [ | ||
"Binder", | ||
"BinderUtils", | ||
"BinderGroupProvider", | ||
"BinderGroup", | ||
"BinderProvider", | ||
"BoundParentTracker", | ||
"BoundAncestorTracker", | ||
"promiseBoundClass", | ||
"BoundChildCollection" | ||
] | ||
|
||
[[classOrder]] | ||
section = "IK" | ||
classes = [ | ||
"ArmIKBase", | ||
"GripPointer", | ||
"IKAimPositionPriorites", | ||
"IKBindersClient", | ||
"IKBindersServer", | ||
"IKConstants", | ||
"IKGripBase", | ||
"IKGripUtils", | ||
"IKLeftGrip", | ||
"IKResource", | ||
"IKResourceUtils", | ||
"IKRig", | ||
"IKRigBase", | ||
"IKRigClient", | ||
"IKRightGrip", | ||
"IKService", | ||
"IKServiceClient", | ||
"IKUtils", | ||
"IKRigUtils", | ||
"TorsoIKBase", | ||
"TorsoIKUtils", | ||
] | ||
|
||
[[classOrder]] | ||
section = "Table" | ||
classes = ["Table", "Set"] | ||
|
||
[[classOrder]] | ||
section = "AttributeUtils" | ||
classes = ["AttributeUtils", "RxAttributeUtils", "AttributeValue"] | ||
|
||
[[classOrder]] | ||
section = "Brio" | ||
classes = ["Brio", "BrioUtils", "RxBrioUtils"] | ||
|
||
[[classOrder]] | ||
section = "Spring" | ||
classes = ["Spring", "SpringUtils", "LinearValue"] | ||
|
||
[[classOrder]] | ||
section = "ValueBaseUtils" | ||
classes = ["ValueBaseUtils", "RxValueBaseUtils"] | ||
|
||
[[classOrder]] | ||
section = "QFrame" | ||
classes = ["QFrame"] | ||
|
||
[[classOrder]] | ||
section = "AdorneeUtils" | ||
classes = ["AdorneeUtils"] | ||
|
||
[[classOrder]] | ||
section = "AccelTween" | ||
classes = ["AccelTween"] | ||
|
||
[[classOrder]] | ||
section = "Camera" | ||
classes = [ | ||
"CameraStackService", | ||
"CameraFrame", | ||
"CameraStateTweener", | ||
"CameraState", | ||
"CameraUtils", | ||
"CameraControls", | ||
"CameraGamepadInputUtils", | ||
"GamepadRotateModel", | ||
"FadeBetweenCamera", | ||
"FadeBetweenCamera2", | ||
"FadeBetweenCamera3", | ||
"FadeBetweenCamera4", | ||
"CameraEffectUtils", | ||
"CustomCameraEffect", | ||
"DefaultCamera", | ||
"FadingCamera", | ||
"HeartbeatCamera", | ||
"ImpulseCamera", | ||
"InverseFader", | ||
"LagPointCamera", | ||
"PointCamera", | ||
"PushCamera", | ||
"RotatedCamera", | ||
"SmoothRotatedCamera", | ||
"SmoothZoomedCamera", | ||
"SummedCamera", | ||
"TrackCamera", | ||
"XZPlaneLockCamera", | ||
"ZoomedCamera", | ||
"CameraInputUtils", | ||
"CameraTouchInputUtils", | ||
"FieldOfViewUtils", | ||
] | ||
|
||
[[classOrder]] | ||
section = "InputMode" | ||
classes = ["InputMode", "InputModeProcessor", "InputModeSelector", "INPUT_MODES"] | ||
|
||
[[classOrder]] | ||
section = "Math" | ||
classes = ["Math"] |
Oops, something went wrong.