This article describes how to set up the development environment for Hexarc (including AeonDB).

Requirements

Building

  • Fork the Hexarc repo from GitHub. This repo contains all projects required to build the core Hexarc installation.
  • Open Hexarc.sln in Visual Studio.
  • Select a configuration of Debug or Release. Select x64 platform. Hexarc currently requires 64-bits.
  • Select Build/Rebuild Solution. If successful, the binary files will be created in x64/Debug or x64/Release.

Running Hexarc

For a complete description of how to run and configure Hexarc, see: Hexarc Quick Start.

  • Right click on the Arcology project and set it as the Start Up Project.
  • Right click on the Arcology project and select Properties. Select Debugging on the left, and enter /debug as a Command Argument on the right pane.
  • Start Arcology.exe from the Debug menu (either with or without debugging).
  • You may get a Windows Defender dialog asking to unblock ports. Allow access to continue.
  • Open a command shell to x64/Debug (the output directory). Run AI1.exe.
  • AI1 will connect to the running Arcology.exe process via localhost. It will ask you to create an administrator account (username and password). After you've created an account, type help for a list of commands.
  • Hexarc stores its database files in c:\Arcology. You may delete files in this directory between runs if you want to reset the installation.
  • Type: uploadPackage AI2 ..\..\Packages\AI2\AI2Package.ars to install the administration service.
  • Open a web browser to localhost. You should see the AI2 Hexarc Command Interface. Sign in using your administrator account. Type help for a list of commands.
  • When you close Arcology.exe (or stop debugging), the server will shut down (nothing is installed and no register entries are modified).

Debugging Hexarc

There are a two separate processes implementing the server. Arcology.exe is the main process which provides a web server and infrastructure for the rest of the system. AeonDB is the database process.

To debug the database process, run Arcology.exe as normal and then select Debug/Attach to Process. Pick AeonDB.exe.

Running AeonDB in Console Mode

You may run AeonDB without the rest of Hexarc.

  • Right click on the AeonDB project and set it as the Start Up Project.
  • Right click on the AeonDB project and select Properties. Select Debugging on the left, and enter /console as a Command Argument on the right pane.
  • Start AeonDB from the Debug menu (with debugging).
  • You will see a command shell. Type help for a list of commands.
  • When in console mode, AeonDB will store its files in c:\ArcologyConsole.