EVE Frontier Builder Examples

🚀 Learn to build in EVE Frontier with examples and guides.

Welcome to EVE Frontier Building!

Welcome, this repository contains guides and examples to get started building on EVE Frontier. For more information, you can visit https://docs.evefrontier.com/.

To start building, follow the steps below to setup your local development tools and environment. If you already have the tools, make sure they are the correct version as otherwise you may have difficulties running the examples and building.

Table of Contents

1. Installing general tools
   • Installing Git
   • Installing Node Version Manager
   • Installing PNPM
   • Installing Foundry + Forge
2. Setting up your environment
   • Prerequisites
   • Deploying world contracts into a local node
3. Start Building!

---

Step 1: Installing general tools

Before you get started you need to either install, or make sure you have the required tools. Install these tools for Linux, if you use a different OS then visit Tools Setup and follow the guide for your operating system.

Installing Git

Install Git through Installing Git.

To confirm Git has been installed run:

git --version

Installing Node Version Manager

Install NVM using this command:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash && source ~/.bashrc

Installing Node

Install Node version 20 by using this command:

nvm install 20

Installing PNPM

Install PNPM, which is used as a more efficient version of NPM with:

npm install -g pnpm

Installing Foundry + Forge

Install foundry and restart the shell with:

curl -L https://foundry.paradigm.xyz | bash && source ~/.bashrc

Run the below command to install forge, cast, anvil and chisel:

foundryup

Step 2: Setting up your environment:

This guide will walk you through setting up a local environment for running a local Anvil node, deploying world contracts using Docker, and pulling ABIs.

Prerequisites

Ensure you have Docker installed on your system: Installation Guide

Deploying world contracts into a local node.

We have provided a docker compose file which bundles the running of the local node/world and deploying the world chain contracts to simulate the existing world. Run that with the command:

docker compose up -d

Monitor the progress of the world deployment with:

docker compose logs -f world-deployer

Once deployment is complete, you should see an output similar to the one below. Make sure to copy the world contract address and save it for future reference.

Retrieving world ABIs (Optional)

You can also retrieve the world abis and save them to the root directory from the deployment by running:

docker compose cp world-deployer:/monorepo/abis .

Step 3: Start Building!

Now that your local tools and development environment is set up, you're ready to start building!

To begin, navigate to the desired example directory then follow the instructions outlined in its README file. For more information on Smart Assemblies you can visit the Smart Assemblies Documentation.

cd smart-storage-unit
cat readme.md

Example Projects

📦 Smart Storage Unit

Create a SSU vending machine for item trading

🎯 Smart Turret

Configure a Smart Turret with a custom strategy

🚪 Smart Gate

Control access to a Smart Gate based on Tribe membership

Need Help?

License

MIT License