rptd-core v1.2.10

rptd-core v1.2.10

rptd-core is a package that allows for generating ruptured levels using code

you can see he source code on github here: rptd-core

Installation

The only pre-requisite is that you have a version of node.js installed.

Then you can create a new project:

npm init

and install the package:

npm install rptd-core

Usage

// import the components
const { jsonUtility, Level, Path } = require('rptd-core')
// create a new level
const level = new Level({ LevelName: 'Example Level' })
// add a new section
level.createSection({ LevelBounds:{ x:-100, y:100, z:100, w:-100 }})

Now you can add tiles and prefabs using level.addTile(...), level.addBGTile(...) etc. (more documentation on all these function below)

Finally you can write the level to a file:

jsonUtility.writeLevelToFile(level, './example_level.json')

Note: it is possible to write directly to a level in your Ruptured levels folder however this is not reccomended if you have the level editor open as it can cause the level loading to break untill you restart the game

Documentation

This is a temporary location for the documentation but it will remain here untill I have time to make an actuall website

jsonUtility

This object contains some helper functions for reading and writing json files and levels

functions

Level

A class that contains all of the data for a Ruptured level, as well as many functions for adding tiles and prefabs. Can be constructed directly using new or generated using jsonUtility.createLevelFromFile(path).

properties

constructor

Takes an object with the following properties (see rptd-core/examples to see how this works):

methods

All of the following methods take an object with the listed properties as a parameter, see rptd-core/examples to see examples

Level meta data methods

setLevelData({ })

Takes the same params as the constructor, and defaults to the current value of those properties

createSection({ })

Creates a new section in the level

Sections are given ids based on the order they are added, starting at 0

addPath({ })

Adds a path object to the specified section

Tile utils

addTile({ })

Adds a tile on the specified section and layer

general methods

addPrefab({ })

note: this function is used under the hood by all prefab utility methods, and it is not reccomended to use this directly, unless there is not yet an implemented method for the desired prefab

Creates a prefab with the specified parameters

addMovingPlatform({ })

General function for adding prefabs that can move along a path

addLogicGate({ })

General function for adding logic gates, not reccommended to use directly (see Logic gate methods)

returns the channels that were used as an object

see rptd-core/examples/gateExample.js for an example

prefab utils

addBooster({ })

addButton({ })

addCheckPoint({ })

addCrate({ })

moving platform prefabs

addToggleWall({ })

General function for adding prefabs that can move along a path

Logic gate methods

addAndGate({ }),addOrGate({ }),addXorGate({ })

Functions for adding and, or, and xor, they all have the same parameters returns the channels that were used as an object (eg: { InChannel1: 3, InChannel2: 4, OutChannel1: 5 })

addNotGate({ })

Function for adding not gates returns the channels that were used as an object (eg: { InChannel1: 3, OutChannel1: 4 })

addLatchGate({ })

Function for adding latches and t-flip-flops (TFF) returns the channels that were used as an object (eg: { OnChannel: 11, OffChannel: 12, OutChannel1: 13})

addClock({ })

Function for adding clocks returns the channel that was used as an object (eg: { OutChannel1: 16 })

Path

Represents a path that a moving platform can follow, to create a ne Path use new Path(id) and then use path.addPosition({ x, y }) to add positions.

constructor

methods

addPosition({ })

takes an object containing the x and y position of the new point, points of a path are followed in order

Appendices

terminology

• Tile: any static tile with no properties, has an id which tells the game what flavor of tile it is, and a position
• Prefab: any entity with setable properties, (eg: buttons, enemies, triggers), these also have an id and position at bare minimum, as well as a "properties" attribute which contains all other entity specific information

channels

• for any prefab utility function, setting the channel to -1 will have the effect of giving it no channel
• setting the channel to -2 (default most of the time) will use the next free channel
• all of these functions return the channels used

layers