The integration of the Clojure Programming Language with the Unity 3D game engine.
Arcadia is alpha-quality software, and shouldn't be used for anything important yet.
The contents of the repository should be copied to a folder named Arcadia in any Unity project's Assets folder to enable Clojure. In the future, this will be available from the Asset Store. Once copied, you have access to the REPL and the Clojure compiler.
- Create a subfolder of your Assets folder named Arcadia
- Download our zip file and extract its contents into Arcadia
cd path/to/unity/project/Assets
git clone https://github.com/arcadia-unity/Arcadia.git
USAGE.md us a good place to start, as is the Wiki. They both cover how to get started and all the prerequisites you'll need. The community on the Gitter is very helpful and happy to answer questions.
Arcadia ships with a simple networked REPL that is started automatically or from Clojure > REPL > Start. To integrate your text editor with Arcadia, there are a few clients listed on the Wiki. Additionally, there are three command line scripts that act as REPL clients if that makes your integration easier. Editor/repl-client.rb, Editor/repl-client.javascript, and Infrastructure/repl. Infrastructure/repl is the future, but not totally stable yet. You should try them all and use what works best.
The core devs use the REPL from Emacs (via Inferior Lisp) and SublimeText (via Socket).
If you're thinking of submitting code to Arcadia – thanks! We're excited to have your help. First, all contributors must read and agree to our contributor license agreement. It is based on GitHub's CLA and ensures that the code you submit remains useable by Arcadia and its community without issue. It confirms that
- Anyone can use your contributions anywhere, for free, forever.
- Your contributions do not infringe on anyone else's rights.
- You retain ownership of your contribution.
Once you have read and agree to it, submit a Pull Request adding your name and GitHub id to CONTRIBUTORS.md with the following commit message:
I have read and agree to the terms of the Arcadia Contributor License Agreement.
You only need to do this once. After that, we can review and merge any contributions you send us!
This project was originally named "clojure-unity", but was changed to "Arcadia" to avoid infinging on Clojure's trademarks. It was suggested to us by @ztellman at a bar during StrangeLoop 2014, and we are eternally grateful.
Copyright © 2014-2017 Tims Gardner, Ramsey Nasser, and contributors.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.