unrooot / nevermore-templates

Nevermore project templates for games, plugins, and packages.

Nevermore Project Templates

This repository consists of 3 different templates that you can use as starting points to build projects that are powered by NevermoreEngine.

---

Prerequesites

It is recommended that you are somewhat familiar with how to use the command-line and know how to use Rojo.

To quote the official Nevermore documentation:

"Getting started with Nevermore is not easy."

Dependencies

Install the following applications and make sure you can run them in your operating system's terminal:

• npm (included with node.js)
• aftman (or foreman)
• rojo

You can download aftman with cargo, which is included with the the Rust programming language.

cargo install aftman

Setup

Download or clone this repository onto your computer.

git clone https://github.com/unrooot/nevermore-templates

Once you've done this, create a folder that will serve as your project's root directory. If you are making a game, copy/paste the contents of the game folder from this repository into the new project folder that you created. If you're making a plugin or package, do the same except with the plugin or package folders instead.

Configuration

These are the files you should pay attention to:

• ./default.project.json

  • This is the file that tells Rojo where to sync the files on your computer into Studio. The included files have been mostly pre-configured, but make sure to update the project name.

• ./package.json

  • Nevermore packages are managed with npm. This file stores your project's dependencies.

• ./aftman.toml or ./foreman.toml

  • aftman/foreman controls the version of rojo that you're using.

For games:

The modules directory can have Client, Shared, and Server folders which will replicate any modules inside of them accordingly.

• modules/Client/GameServiceClient.lua and modules/Server/GameServiceServer.lua
  • Initializes services on the client/server.

For packages:

The src/ folder should contain the Client, Shared, and Server folders.

For plugins:

The src/projectName/modules/ folder should contain the Client, Shared, and Server folders.

• src/projectName/init.server.lua
  • Bootstraps plugin modules.

Usage

Nevermore is designed to use npm to manage packages. You can install some of the most common ones in with the command:

# example
npm install @quenty/package

# common packages
npm install @quenty/maid
npm install @quenty/signal
npm install @quenty/binder
npm install @quenty/rx
npm install @quenty/blend

If you're serving a Nevermore project for the first time that has dependencies, install them with:

npm install

For games:

Serve rojo from your project's root directory. You can do so with:

rojo serve

For plugins:

Serve rojo from the ./test/ directory. If you need to build your plugin, you can do so with:

rojo build -o ./build/plugin.rbmxm

For packages:

Serve rojo from the ./test/ directory.

cd test && rojo serve