Setting Up

This diagram shows the overall flow of setting up Odyssey. Please take some time to look through it.

⚙️ Pre-Setup

1. Install the latest Node.js version.

2. Register Arweave via https://arweave.app/ and download your Arweave wallet’s keyfile.json file by navigating to ‘Settings’ at the bottom left hand corner. Scroll down until you find the ‘Backup Keyfile’ button. Your keyfile json file will be downloaded.

1. Ensure that your NFT art asset files (eg. trait images) are in .png or .jpeg format on your local machine

Note: You can purchase $AR tokens from a CEX and transfer it into your Arweave wallet. You also need ~$5 worth of $AR in your Arweave wallet address to process the file upload transactions on the Arweave blockchain.

⚙️ Setup

The following steps vary in the way it is carried out. Some are carried out on the CLI while some can be done through your machine’s interface. The indicators are as follow:

[CLI] : Command Line Interface - code to be written on the CLI for machine to execute.

[Interface] : Drag / drop actions

1. [CLI] Create your Minting Folder

In the example shown below, ‘odyssey is the folder name.

mkdir odyssey

cd odyssey

1. [Interface] Copy / drag and drop your Arweave wallet keyfile **.json file into the Minting Folder

2. [CLI] Create your Assets Folder within the Minting Folder

mkdir assets

cd assets

In order to locate this folder, navigate to Macintosh HD -> Users -> [DEVICE NAME] -> odyssey. For Windows, you should be able to locate it in your C drive -> Users.

At this point, this is how your Minting Folder should look like on your machine’s user interface.

1. Uploading of art files into the Asset Folder varies depending on the need to use the Trait Randomiser feature.

• If you intend to use the Randomiser feature, refer to Randomizer.

• If you do not intend to use the Randomiser feature, refer to the steps below.

[Interface] Copy your asset files (both metadata json and image files) into the Assets Folder.

Please ensure that each image have its corresponding metadata json file. You would have to generate this on your own. They must be ordered in sequence starting from 1 (as shown below):

Example of the metadata json file. Take note that the ‘image’ field should be left empty initially.

Post mint, Odyssey will update this image path as shown below.

Below is an example of how your Assets Folder should look.

1. [CLI] Enter the following command to go back to the root folder:

cd ..

Your terminal should now be pointing to the Minting Folder

IMPORTANT:

For Windows users, please ignore this portion.

For Mac users, please go through the following commands:

Use the following command to give full access to the ‘node modules’ folder that is created together with the npm package.

sudo chown -R $(whoami):staff /usr/local/lib/node_modules/

sudo chown -R $(whoami):staff /usr/local/bin

Use the following command to clear the cache within the entire npm package

sudo chown -R $(whoami) ~/.npm

npm cache clean --force

Install Homebrew and add it into your path

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

brew install pkg-config cairo pango libpng jpeg giflib librsvg

1. [CLI] Enter the following command to install the Odyssey CLI:

npm install -g odyssey-cli

End of page