mirror of
https://github.com/SashLilac/cambridge.git
synced 2024-11-22 23:39:02 -06:00
57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
Cambridge
|
|
=========
|
|
|
|
Welcome to Cambridge, the next open-source falling-block game engine!
|
|
|
|
|
|
Installation instructions
|
|
-------------------------
|
|
|
|
Pre-built releases are available on the releases page.
|
|
|
|
### Windows
|
|
|
|
Unzip the exe file and run it directly. All assets are currently bundled inside the executable.
|
|
|
|
### macOS
|
|
|
|
For the time being, the file `cambridge.love` only works on the command line. Install `love` with [https://brew.sh/](Homebrew), and run:
|
|
|
|
$ love cambridge.love
|
|
|
|
### Linux
|
|
|
|
Same as macOS, except install `love` with your favourite package manager.
|
|
|
|
|
|
Running from source
|
|
-------------------
|
|
|
|
If you want the bleeding-edge release, you can also clone the code straight from this repository.
|
|
|
|
### macOS, Linux
|
|
|
|
If you haven't already, install `love` with your favourite package manager (Homebrew on macOS, your system's default on Linux). **Make sure you're using LÖVE 11, because it won't work with earlier versions!**
|
|
|
|
Clone the repository in git:
|
|
|
|
git clone https://github.com/joezeng/cambridge
|
|
|
|
Then, navigate to the root directory that you just cloned, and type:
|
|
|
|
love .
|
|
|
|
It should run automatically!
|
|
|
|
|
|
License
|
|
-------
|
|
|
|
The Cambridge project is licensed under the MIT license (included in LICENSE.md).
|
|
|
|
Some code and assets in this repository are contributed by members of the
|
|
community, as well as borrowed from other places, either with licensing
|
|
or as placeholders until suitable material can be found that is properly
|
|
licensed. Their original sources, and copyright notices if applicable, are
|
|
listed in the file SOURCES.
|