Skip to content

Home

Jump to bottom
ZeeAy edited this page Dec 1, 2024 · 6 revisions

Welcome to the Eklips wiki!

This wiki will show all documentation on the Sol Superset language and how to start using Eklips. This is for developers looking to use Eklips to make games, if you are a user please go to the User Manual.

Getting Started

Here is a basic guide to get started with using Eklips.

Table of Contents

  1. Setting up the data directory
  2. Modifying basic assets
  3. Wiki

Setting up the data directory

In this repo of Eklips, the data directory is "eklips" which includes media, data, etc.. to modify the name, first rename the folder, and go to the game.txt file at the root which should look like:

Eklips 3.1.0
eklips

The first line is the name of the game which will be shown in the titlebar and the name of the user data directory (~/Za9118/Eklips Engine). The second line is the name of the data folder (eklips), if you rename the data folder you need to change this line to the new name.

Modifying basic assets

Now that you have your data folder set up, you can go to the media folder inside. Inside is:

icon.png      // Picture of your game icon
null.png      // Unused image
load.mp3      // Sound that plays when the game is loading
click.mp3     // Unused click noise
gdev.png      // Picture of your logo
eklips        // Folder with Eklips icons
 | icon.png   // Eklips icon
 | ring.png   // Used for loading animation
 | eklips.png // Used for loading animation
sheet         // Folder for spritesheets images, data is in *../data/sheet*
 | player.png // Player spritesheet

In this folder you can modify any of these files to your liking.

Wiki Pages

Here are the pages for all the classes and namespaces for the Sol language.

Clone this wiki locally