Getting Started - dorian-K/Elafalter-ExampleMod GitHub Wiki

Before you can start creating scripts, you first need to install Elafalter, you can download it here.

If you're new to Elafalter, try using a few mods and see if they work as expected. The core mod should load by default and provides some basic mods like Speed or Jetpack.

Running the Example Script

Requirements:

  • NodeJS (And added to your path)
  • Git (Optional if you choose to download the repository via zip)

Run the following commands in a command prompt:

  1. Clone the repository: git clone https://github.com/dorian-K/Elafalter-ExampleMod.git
  2. cd Elafalter-ExampleMod
  3. Install dependencies: npm install
  4. npx webpack to bundle all source code into a single file

If everything has worked successfully, you should now have a bundled script in your dist folder which you can import to elafalter!

Importing scripts into Elafalter

Before you can import a script into Elafalter, you first need to launch Elafalter! Click 'Launch' in the Launcher and wait until it's loaded up and menus have appeared on your screen.

Once Elafalter is fully loaded up, you can go back into the Launcher and open the 'Toolbox' Tab (Second tab, click the toolbox button on the left sidebar).

Inside the toolbox, select 'Load Script File' and open bundle.js inside the dist folder.

If you have done everything correctly, the example mod should now show up in the Script window in the game, and you can proceed to the next wiki page!