Reldens - Documentation
Go to websiteCheck our demo!Source GitHub
  • Documentation
  • What is Reldens?
  • Admin Panel
  • System Configuration
  • Contents creation
  • Customize your game
  • Demo server setup - Amazon Linux (2024)
  • Generators and import
  • Installation
  • Known issues
  • How to create a new Room/Scene?
  • Maps Wizard
  • System requirements
  • assets
    • object-sprite
    • player-sprite
    • skill-sprite
  • entities
    • Class Path
    • Item
    • Level Modifiers
    • Level
    • Levels Set
    • Objects
    • Respawn Areas
    • Rooms
    • Skill Types
    • Skill
    • Stats
    • Target Options
  • general
    • Actions
    • Create and configure a player spritesheet
    • Events Manager
    • Operations
    • Plugins
    • Project structure
  • generators
    • Attributes per level generator
    • Enemies experience rewards per level
    • map-composite-file
    • maps-elements
    • Generate multiple maps by loader generator
    • Generate multiple maps with associations by loader generator
    • Generate a single map by elements composite loader
    • Generate a single map by elements object loader
    • Players experience per level generator
  • importers
    • Objects Importer
    • Skills Importer
  • packages
    • tile-map-generator
      • The "composite" approach
      • Tile Map Generator
      • The "objects" approach
Powered by GitBook
On this page
  • - [project-root]/theme/default
  • - [project-root]/theme/packages
  • - [project-root]/theme/custom-game-theme-test
  • - [project-root]/dist
  1. general

Project structure

To analyze the folder structure we are going to check the skeleton project, which is how your project will look:

https://github.com/damian-pastorini/reldens-skeleton

After you installed Reldens you are going to see is the following:

- [project-root]/theme/default

This is the default theme of the Platform. It's used on the demo, and we keep it there for the base installation of the project.

If you look at the platform repository (/theme/default) this is the only theme folder you will see.

In the skeleton repository we included some build scripts in the package file to help developer with the project initialization.

https://github.com/damian-pastorini/reldens-skeleton/blob/master/package.json

- [project-root]/theme/packages

This is where all your custom project classes should go.

This also can be found as the only packages folder in the platform repository (/theme/packages).

In this folder you will find the client and server JS files where you can define all your custom classes.

By default, you will see all the demo examples of each class group (objects, inventory, skills, for now).

- [project-root]/theme/custom-game-theme-test

As you can see this folder doesn't exist in the platform repository (/theme), and that's because it's created just as an example on how you could create your own themes.

- [project-root]/dist

This is where the default bundler (Parcel) will generate the project public files.

This is the generated "client-side" of your project, which can be uploaded anywhere (like any CDN), so you can distribute your game and from there connect to your server.

PreviousPluginsNextgenerators

Last updated 3 months ago