diff --git a/docs/src/index.md b/docs/src/index.md index 18d46597e..8c404a012 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -7,79 +7,80 @@ Zooshi {#zooshi_index} [Zooshi][] is a game in which players travel on a raft down an endless river and toss sushi into the mouths of well-dressed animal patrons. It is written in cross-platform C++. - +``` \htmlonly \endhtmlonly +```` ## Motivation -[Zooshi][] demonstrates a quick and fun game that primarily targets -[Google Cardboard][] using native C++ APIs. The game shows how to use +[Zooshi] demonstrates a quick and fun game that primarily targets +[Google Cardboard] using native C++ APIs. The game shows how to use several open source technology components developed at Google. @@ -93,42 +94,42 @@ several open source technology components developed at Google.
- - [Breadboard][], an event system that allows game components to communicate + + [Breadboard], an event system that allows game components to communicate with each other, without being tightly coupled.
- - [CORGI][], a simple, yet flexible, [entity-component system][] that + + [CORGI], a simple, yet flexible, [entity-component system][] that decouples the systems within the game.
- - [FlatBuffers][], a fast serialization system is used to store the game's + + [FlatBuffers], a fast serialization system is used to store the game's data. The game configuration data is stored in JSON files which are converted to FlatBuffer binary files using the flatc compiler.
- - [FlatUI][], an immediate-mode GUI designed specifically with games in mind. + + [FlatUI], an immediate-mode GUI designed specifically with games in mind. The game uses FlatUI to generate all of the menus in the game.
- - [fplbase][], is as a thin renderer and asset management library used by the + + [fplbase], is as a thin renderer and asset management library used by the game.
- - [Google Play Games Services][] is used to share scores and reward players + + [Google Play Games Services] is used to share scores and reward players with achievements.
- - [MathFu][], a geometry math library optimized for ARM and x86 processors. + + [MathFu], a geometry math library optimized for ARM and x86 processors. The game uses MathFu data types for two and three dimensional vectors, and - for the 4x4 matrices used by the [fplbase][] rendering system, and also by - the [Motive][] animation system. + for the 4x4 matrices used by the [fplbase] rendering system, and also by + the [Motive] animation system. - [Motive][], a memory efficient and performant animation library. The game + [Motive], a memory efficient and performant animation library. The game uses Motive for all of the animation.
- - [Pindrop][], a simple audio engine designed with games in mind. It handles + + [Pindrop], a simple audio engine designed with games in mind. It handles all the audio of the game.
- - [WebP][], an image compression technology, is used to compress textures + + [WebP], an image compression technology, is used to compress textures which reduces the size of the final game package and ultimately reduces download time.
-In addition, [fplutil][] is used to build, deploy, and run the game, +In addition, [fplutil] is used to build, deploy, and run the game, build and archive the game, and profile the game's CPU performance. ## Functionality -[Zooshi][] is a cross-platform, open-source game that supports: +[Zooshi] is a cross-platform, open-source game that supports: * Bluetooth controllers * Touch controls * Google Play Games Services sign-in and leaderboards * Android devices - Phones and tablets - - Virtual reality via a [Google Cardboard][] device + - Virtual reality via a [Google Cardboard] device ## Supported Platforms -[Zooshi][] has been tested on the following platforms: +[Zooshi] has been tested on the following platforms: - * [Nexus Player][], an [Android TV][] device - * [Android][] phones and tablets - * [Linux][] (x86_64) - * [OS X][] - * [Windows][] + * [Nexus Player], an [Android TV] device + * [Android] phones and tablets + * [Linux] (x86_64) + * [OS X] + * [Windows] -We use [SDL][] as our cross platform layer. +We use [SDL] as our cross platform layer. The game is written entirely in C++, with the exception of one Java file used -only on Android builds. The game can be compiled using [Linux][], [OS X][] or -[Windows][]. +only on Android builds. The game can be compiled using [Linux], [OS X] or +[Windows]. ## Download @@ -138,8 +139,8 @@ only on Android builds. The game can be compiled using [Linux][], [OS X][] or * [Google Play][] (binary for Android) -**Important**: [Zooshi][] uses submodules to reference other components it -depends upon, so download the source from [GitHub][] using: +**Important**: [Zooshi] uses submodules to reference other components it +depends upon, so download the source from [GitHub] using: ~~~{.sh} git clone --recursive https://github.com/google/zooshi.git @@ -148,9 +149,9 @@ depends upon, so download the source from [GitHub][] using: ## Feedback and Reporting Bugs * Discuss Zooshi with other developers and users on the - [Zooshi Google Group][]. - * File issues on the [Zooshi Issues Tracker][]. - * Post your questions to [stackoverflow.com][] with a mention of + [Zooshi Google Group]. + * File issues on the [Zooshi Issues Tracker]. + * Post your questions to [stackoverflow.com] with a mention of **zooshi**.