SashLilac
/
cambridge
mirror of https://github.com/SashLilac/cambridge.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
cambridge/README.md

76 lines
2.6 KiB
Markdown
Raw Normal View History

Update README.md
2020-10-19 07:45:22 -05:00
![Cambridge Banner](https://cdn.discordapp.com/attachments/764432435802013709/767724895076614154/cambridge_logo_lt.png)
Fixed up the docs.
2019-05-31 22:59:04 -05:00
Cambridge
=========
Welcome to Cambridge, the next open-source falling-block game engine!
Update README.md
2020-10-06 09:20:01 -05:00
This fork is written and maintained exclusively by [SashLilac](https://github.com/SashLilac) and [Oshisaure](https://github.com/oshisaure)!
Update README to fork
2020-09-24 21:23:05 -05:00
Update README.md
2020-10-12 13:48:00 -05:00
Join our Discord server for help and a welcoming community! https://discord.gg/mteMJw4
Update README.md
2020-10-06 09:20:01 -05:00
Credits
-------
Update README.md
2020-10-06 09:22:23 -05:00
- [Lilla Oshisaure](https://www.youtube.com/user/LeSpyroshisaure) for their amazing contributions to my life in general!
- [The Tetra Legends Discord](http://discord.com/invite/7hMx5r2) for supporting me and playtesting!
- [joezeng](https://github.com/joezeng) for the original project.
Update README.md
2020-10-10 09:30:31 -05:00
- [Hailey](https://github.com/haileylgbt) for some miscellaneous assets.
Update README.md
2020-10-23 20:28:32 -05:00
- CylinderKnot for an amazing gamemode.
Update README.md
2020-10-19 07:45:22 -05:00
- MarkGamed7794 for some miscellaneous contributions.
- Mizu for the Cambridge logo and the [Cambridge launcher](https://github.com/rexxt/cambridge-launcher).
- MattMayuga for the Cambridge banner.
Fixed up the docs.
2019-05-31 22:59:04 -05:00
Update README.md
2020-10-13 14:56:11 -05:00
![Cambridge Logo](https://cdn.discordapp.com/attachments/625496179433668635/763363717730664458/Icon_2.png)
Fixed up the docs.
2019-05-31 22:59:04 -05:00
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
Update README to fork
2020-09-24 21:23:05 -05:00
For the time being, the file `cambridge.love` only works on the command line. Install `love` with [Homebrew](https://brew.sh), and run:
Fixed up the docs.
2019-05-31 22:59:04 -05:00
$ love cambridge.love
### Linux
Updated the README with instructions for running the trunk release.
2019-06-04 10:44:39 -05:00
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:
Update README to fork
2020-09-24 21:23:05 -05:00
git clone https://github.com/SashLilac/cambridge
Updated the README with instructions for running the trunk release.
2019-06-04 10:44:39 -05:00
Then, navigate to the root directory that you just cloned, and type:
love .
It should run automatically!
Fixed up the docs.
2019-05-31 22:59:04 -05:00
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.