Giter Club home page Giter Club logo

synglechance's Introduction

SyngleChance

This is a specialized fork of mkxp by Ancurio designed for OneShot.

Prepare

There are a few prerequesites you must install before proceeding. They are:

  • Conan
  • CMake
  • Windows only:
    • Visual Studio
  • macOS only:
    • Xcode
  • Linux only:

If you are compiling a version for Steam, you will also need to download the Steamworks SDK. Once you have downloaded it, place the folder in the project root and rename it to steamworks.

Once you have installed these dependencies, Conan will take care of the remaining ones. Run the following commands to configure Conan:

conan remote add queengooborg https://queengooborg.jfrog.io/artifactory/api/conan/default-conan
conan remote add bincrafters https://bincrafters.jfrog.io/artifactory/api/conan/public-conan
conan config set general.revisions_enabled=1

On Windows, additionally run the following:

setx CONAN_USE_ALWAYS_SHORT_PATHS 1

Building

Building the engine is tested and supported on Windows, macOS, and Ubuntu Linux.

Windows

Launch a command prompt that can run Visual Studio commands. The easiest way to do this is to open Visual Studio and click Tools -> Command Line -> Developer Command Prompt (or Developer PowerShell if prefered). Then, run the following commands:

mkdir build
cd build
conan install .. --build=missing
conan build ..

macOS

All of the steps on macOS are automated by a single command. Simply run the following:

./make-mac.command

Linux

./make-linux.sh
./make-appimage.sh . build </path/to/game/files> /build/_______ /build/_______.AppImage`

Installation

Simply copy the generated binaries in the build/ folder to your OneShot game folder, available through Steam. By design, the game will not run without a copy of the game through Steam.

Installation is automatic using the following command on macOS or Linux:

./install-mac.command # macOS
./install-linux.sh # Linux

Running OneShot

These depend on the SDL auxiliary libraries. OneShot only makes use of bmp/png for images and oggvorbis/wav for audio.

To run OneShot, you should have a graphics card capable of at least OpenGL (ES) 2.0 with an up-to-date driver installed.

Configuration

OneShot reads configuration data from the file "oneshot.conf". The format is ini-style. Do not use quotes around file paths (spaces won't break). Lines starting with '#' are comments. See 'oneshot.conf.sample' for a list of accepted entries.

All option entries can alternatively be specified as command line options. Any options that are not arrays (eg. preloaded scripts) specified as command line options will override entries in oneshot.conf. Note that you will have to wrap values containing spaces in quotes (unlike in oneshot.conf).

The syntax is: --<option>=<value>

Example: ./oneshot --gameFolder="oneshot" --vsync=true

Credits

Please view CREDITS.txt.

synglechance's People

Contributors

ancurio avatar blacklotus avatar carstene1ns avatar cloudef avatar cremno avatar daverball avatar elizagamedev avatar girakacheezer avatar jaidenalemni avatar kockaadmiralac avatar lacc97 avatar mathewv avatar meiraxg avatar mook avatar mshirt avatar popkirby avatar queengooborg avatar reinuseslisp avatar speak2erase avatar speak2erase2 avatar taedixon avatar urkle avatar vmedea avatar

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.