Skip to content

Commit

Permalink
Readme and license
Browse files Browse the repository at this point in the history
* Create LICENSE

* Update README.md
  • Loading branch information
ccontinisio authored Aug 10, 2023
1 parent 3c4bb6f commit 9d1aec3
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 coherence Filial

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
![Campfire tutorial](https://github.com/coherence/campfire-tutorial/assets/5457632/8784356b-8247-4314-abb6-2100b5e4f596)

Campfire is a tutorial project for coherence, a Unity networking framework.
It is a slightly advanced demo, so if you are new to coherence, we recommend starting from the [First Steps](https://docs.coherence.io/learning-coherence/first-steps-tutorial) tutorial project.

The Campfire project explores these topics:

- Object pooling
- Interacting with remote objects
- Creating a unique object
- Syncing complex states
- Custom instantiation and destruction
- Server-side NPCs (Simulators)
- Playing audio and particles over the network
- Creating a simple chat feature

### Unity version
Currently the project is on Unity `2022.3.5f1`.

## Additional resources

### Documentation
After downloading this Unity project, we suggest to open up the [documentation](https://docs.coherence.io/learning-coherence/campfire-project) as it's the perfect companion to explore the topics above.

### Trying a pre-made build
To quickly try a pre-built version of the game, head to [this link](https://coherence.io/games/coherence/campfire-tutorial) and either play the WebGL build in the browser, or download one of the available desktop versions.

## Bug reporting
Feel free to open an issue right here on Github if you find anything that is not working in Campfire. Please include also any suggestion you migth have on how to improve it. We appreciate all contributions!

0 comments on commit 9d1aec3

Please sign in to comment.