HoloOcean
UE4.27_archival_develop

HoloOcean Documentation

  • Installation
  • Getting Started & Examples
  • Using HoloOcean
  • HoloOcean Packages
  • HoloOcean Agents
  • Developing HoloOcean
    • Getting Started
    • Developing Environments
    • Developing Sensors
    • Developing Agents
    • Communication Protocol
  • Changelog
  • Other Versions Documentation

API Documentation

  • HoloOcean
  • Agents
  • Environments
  • Spaces
  • Commands
  • HoloOcean Client
  • Package Manager
  • Sensors
  • LCM
  • Shared Memory
  • Util
  • Exceptions
  • Weather Controller
HoloOcean
  • Developing HoloOcean
  • View page source

Developing HoloOcean

This documentation should be enough to get up and starting with developing HoloOcean. If you notice an obvious gap, please feel free to open an issue or pull request to fill it!

We’ve tried to be thorough here, but there may be a bit more information to be had by navigating through holodeck’s documentation.

Content:

  • Getting Started
    • Cloning
    • Opening & Prepping Project
    • Setting up VSCode
    • Compiling
    • Launching Game Live
    • Logging
  • Developing Environments
    • Adding HoloOcean Worlds
    • Cooking Content
    • Packaging holodeck-engine
    • Place in install directory
    • Note on creating environment objects and Sonar:
  • Developing Sensors
    • C++
    • Python
    • Allowing Your Sensor to Be Used In Holoocean
  • Developing Agents
    • General Agents
    • Buoyant Agents
  • Communication Protocol
    • Prerequisite Reading
    • The Two Halves of holoocean
    • Simple Usage Example
    • Part 1: holoocean.make()
    • Part 2: .step()
    • Remarks
Previous Next

© Copyright BYU FRoStLab.

Built with Sphinx using a theme provided by Read the Docs.