Giter Club home page Giter Club logo

otucha's Introduction

otucha Build Status Coverage Status

A cross-platform OpenGL program written in C++. Builds and runs natively on Windows, OSX and Linux. Runs in Chrome, Firefox and Safari when built with Emscripten.

In Progress

  • Increasing code coverage using the custom OpenGL and GLEW mock lib

Developer Setup

  1. Install the following, paying careful attention to any platform specific instructions:
  • CMake - (currently using 3.4.1)

    • OSX: Launch the CMake app after copying it to your Applications and follow the instructions found under Tools > How to Install For Command Line Use
  • Emscripten from here - (currently using 1.35.0)

    • OSX:

      • Put the extracted emsdk_portable in your home directory

      • Follow the Platform-specific notes

      • You can install Python 2.7.10 here instead of doing the last step in the Platform-specific notes since that step may not work. Do not use Python 3.

      • Open a command prompt in the emsdk_portable directory and run these commands:

        ./emsdk update
        ./emsdk install latest
        ./emsdk activate latest
        source ./emsdk_env.sh
      • Add the following line to your ~/.bash_profile:

        alias initem='source ./emsdk_portable/emsdk_env.sh'
      • Before compiling JavaScript, make sure you have run this in your command prompt once:

        initem
    • Windows:

      • Activate the MinGW toolchain.

        emsdk install mingw-4.6.2-32bit
        emsdk activate mingw-4.6.2-32bit
      • Open the Emscripten Command Prompt and run these commands:

        emsdk update
        emsdk install latest
        emsdk activate latest
  • NodeJS from here - (currently using 4.2.1)

    • Emscripten uses a different version when you run initem
  • Grunt - (currently using 0.1.13)

    • Windows: Run the following in a command prompt:

      npm install -g grunt-cli
    • OSX: Run the following in a command prompt:

      sudo npm install -g grunt-cli
  • Bower - (currently using 1.6.5)

    • Windows: Run the following in a command prompt:

      npm install -g bower
    • OSX: Run the following in a command prompt:

      sudo npm install -g bower
  1. Run the following command from the repository root:

    npm install
    
  2. Update the version of npm that came with NodeJS to the latest:

  • OSX: Run the following in a command prompt:

    sudo npm install npm -g
  • Windows:

    • Run the following in a command prompt:

      npm install npm -g
    • Delete the npm and npm.cmd files from the \Program Files\nodejs directory.

Building web

  1. Run the following command in the repository root after running initem:
grunt build:js
  1. Open www/index.html in Chrome, Firefox or Safari (OSX)

Grunt options

--jsMin - Runs uglify with mangle and compress options on the output JavaScript

--jsUseDist - Support is temporarily removed. Uses pre-built JS and HTML for git deploy on a server that does not have CMake and Emscripten available.

Building native

  1. Run the following command from the repository root:
grunt
  1. Build using the generated files under the build directory. For example, if developing on Windows with Visual Studio, open the otucha.sln, build and run. If developing on Mac or Linux, build using the Makefile.

Building with Xcode

  1. Run the following command from the repository root:
grunt cmake:xcode

Xcode will launch when completed.

  1. Switch the target from ALL_BUILD to otucha
  2. Build and run

What you'll see

A perspective view of a copper cube and three lights in positions that produce specular highlights. Some rendered text also appears on the bottom left corner.

Live Demo - It may take a minute for the server to wake up since "Always On" is turned off.

Code names

Like otucha, these code names have no special meaning and are picked using the random page feature on Wikipedia. They are used for namespaces.

RFFalcon: Short for Red-Footed Falcon. Geometry, models and rendering. Point and Matrix classes including vec union structs. Text rendering with C++ OpenGL layer on top of FreeType.

Terasca: Simple MVC application framework utilizing GLFW and GLEW.

Warbler: Console and logging.

otucha's People

Contributors

dpwolfe avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

otucha's Issues

package.json missing dependencies

I tried to build per the instructions, but it looks like coffeescript and a few other packages are required but not listed as dependencies in package.json. I've been going through and installing the missing ones as they are reported, but this seems like an issue that should be fixed. Looking forward to trying this.

Minor documentation issue

On XCode, you won't see the copper cube as advertised unless you switch from the ALL_BUILD target to "otucha" and select Run. This may seem small, but it wasn't initially obvious to me.

grunt build:js issue

I'm on a Mac (OS 10.10) with all the tools installed (node 0.12.7, cmake 3.2.1, emscripten 1.34.4). I've put emscripten on my system path so I can emcc and emmake from anywhere and have successfully compiled with emscripten.

When I ran "grunt cmake:xcode" in the otucha directory, it worked great. The project was generated and built perfectly.

When I run "grunt build:js", I get the following:

Running "build:js" task
Running "shell:emscripten_cmake" (shell) task
Running "shell:emscripten_cmake" (shell) task
Running "shell:emscripten_make" (shell) task
Warning: Command failed: /bin/sh -c cd embuild&&make
make: * No targets specified and no makefile found. Stop.
Use --force to continue.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.