Index
b'# Macroverse Truffle Box\n\nThis box comes with everything a developer needs to use [Macroverse](https://macroverse.io) in an Ethereum dapp or game.\n\n[](https://matrix.to/#/#macroverse:matrix.org)\n\n## What is Macroverse\n\nMacroverse is a procedurally generated universe, available to be used by blockchain-based games. Rather than paying expensive gas costs to store environment and level data on the blockchain, or spending large amounts of developer effort on custom world generation algorithms, game developers can use Macroverse as a piece of game development middleware, and can find settings for their games by exploring the single, shared Macroverse universe. Macroverse provides trusted, proven world generation algorithms, and a shared universe accessible to all developers, allowing even small developers to make big games.\n\nAccess to the Macroverse system is controlled by a token, [MRV](https://etherscan.io/token/0xAB6CF87a50F17d7F5E1FEaf81B6fE9FfBe8EBF84), which functions as a software license. An Ethereum account must hold a minimum balance, currently **100 MRV**, in order to query the Macroverse system on the live Ethereum network.\n\n### Macroverse Game Ideas\n\n* Develop an on-chain version of [Konquest](https://games.kde.org/game.php?game=konquest), played in a different galactic sector every time.\n* Build a galaxy-spanning space trading game, with commodities in each station tradeable using smart contracts.\n* Create a single-player 4X game, played in the browser. Take payments from players in Ether, with no app store needed.\n* Use procedurally-generated terrain from Macroverse planets as the setting for an off-road racing simulator.\n* Devise an orbital-mechanics-based strategy game, set around the moons of a gas giant. Make gameplay proceed in real time, and use blockchain technology to stop cheaters.\n\n### Macroverse Development Status\n\nCurrently, only the first major release of Macroverse, code-named **Cannon**, is deployed on the live Ethereum network. This release includes a galaxy of over 200 billion procedural stars, but does **not** currently implement planetary systems, orbital mechanics, or planetary terrain. Development of the next release, **Kepler**, can be tracked in the [Macroverse Github repository](https://github.com/NovakDistributed/macroverse). Bugs found in the Macroverse contracts should also be reported there.\n\n## Getting Started\n\nUse this box with:\n\n```\ntruffle unbox NovakDistributed/macroverse-truffle-box\n```\n\nThis will create a default Macroverse-enabled Truffle project, with the `macroverse` NPM module installed as a dependency, and with a Truffle migration script to enable testnet deployment of the Macroverse Generator and Macroverse Registry contracts.\n\n### Macroverse Star Generator Technical Background\n\nThe Macroverse Star Generator is a smart contract, deployed at address `0xc9650c155Bb268A1667B5F9c68701638cAE93d3f`, which is responsible for the procedural generation of the galaxy of stars that comprise the Macroverse universe. The galaxy is divided into sectors measuring 25 lightyears on a side. The universe as a whole extends 10,000 sectors in both directioons in X, Y, and Z from the origin, but most of the stars are concentrated in the galaxy, which consists of a disk with a radius of 6,800 sectors in the XZ plane, and a central spherical bulge with a radius of 1000 sectors.\n\nFrom the X, Y, and Z coordinates (in integers) of each sector, the number of objects (stars, black holes, or similar) in the sector is generated. From the sector coordinates and the object index, the object\'s seed is generated. The seed of an object serves as its unique identifier for the virtual real estate system, and is also used to generate its properties.\n\nEach object in the Macroverse world is assigned an `ObjectClass` from the following list:\n\n* `Supergiant`\n* `Giant`\n* `MainSequence`\n* `WhiteDwarf`\n* `NeutronStar`\n* `BlackHole`\n\nActual stars are assigned a `SpectralType` according to the [Harvard Spectral Classification](http://astronomy.swin.edu.au/cosmos/H/Harvard+Spectral+Classification) system.\n\nAdditionally, each object has an X, Y, Z position within its sector in light years, and a mass in solar masses. These are fractional values; since Solidity does not provide native support for non-integer types, these values are represented as fixed-point values (stored in a Solidity `int128`) with 40 fractional bits. The [RealMath Solidity library](https://github.com/NovakDistributed/macroverse/blob/master/contracts/RealMath.sol) is provided for working with these values in smart contracts, and the `macroverse` NPM module provides utility functions for converting to and from them in JavaScript code.\n\nFinally, each object has a flag indicating whether there are planets orbiting it. The actual planetary systems cannot yet be generated (they are coming in the [Kepler phase of Macroverse development](https://macroverse.io/#dev)), but the planetary system generation logic, when deployed, will respect this flag.\n\n### Querying the Macroverse Star Generator from JavaScript\n\n```\n// Make sure you have the Macroverse JavaScript library\nconst mv = require("macroverse")\n\n// Get the Macroverse contract\n// In Truffle testing code (assuming you have Truffle\'s `artifacts` in scope), you would do:\n// const MacroverseStarGenerator = artifacts.require("MacroverseStarGenerator")\n\n// In real code, using truffle-contract\nconst TruffleContract = require("truffle-contract")\nconst MacroverseStarGenerator = TruffleContract(require("macroverse/build/contracts/MacroverseStarGenerator.json"))\n\n// You may need to point the contract at your web3 provider here\n\n// Either way, you need to get the deployed instance of the contract\nconst generator = await MacroverseStarGenerator.deployed()\n\n// Then you can get the number of objects in a sector\nlet objectCount = generator.getSectorObjectCount.call(0, 1, -1)\n\nfor (let i = 0; i < objectCount; i++) {\n // Then you can loop over the objects and get the seed for each one\n let seed = await generator.getSectorObjectSeed.call(0, 1, -1, i)\n \n // And then you can get properties of the object, like its class\n let objectClass = await generator.getObjectClass.call(seed)\n \n // Use the Macroverse JS module to convert integers -> object class names\n console.log("Object " + i + " is a " + mv.objectClasses[objectClass])\n}\n```\n\nThe full Macroverse Star Generator API is documented inline in the [smart contract source](https://github.com/NovakDistributed/macroverse/blob/master/contracts/MacroverseStarGenerator.sol).\n\n\n'