Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aloisdeniel/Comora
A simple 2D camera for Monogame.
https://github.com/aloisdeniel/Comora
camera monogame
Last synced: 3 months ago
JSON representation
A simple 2D camera for Monogame.
- Host: GitHub
- URL: https://github.com/aloisdeniel/Comora
- Owner: dotnet-ad
- License: mit
- Created: 2016-08-29T11:20:58.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-07-17T15:20:44.000Z (over 5 years ago)
- Last Synced: 2024-05-01T13:52:14.499Z (6 months ago)
- Topics: camera, monogame
- Language: C#
- Homepage:
- Size: 1.49 MB
- Stars: 85
- Watchers: 6
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-monogame - Comora -  - A simple 2D camera for MonoGame. (Helpers)
README
# Comora
A simple 2D camera for [Monogame](http://www.monogame.net/).
## Install
Available on NuGet
[](https://www.nuget.org/packages/Comora/)
## Quickstart
```sharp
private Camera camera;
protected override void Initialize()
{
this.camera = new Camera(this.graphics);
base.Initialize();
}
protected override void Update(GameTime gameTime)
{
this.camera.Update(gameTime);
this.camera.Position = Mouse.GetState().Position.ToVector2();
base.Update(gameTime);
}
protected override void Draw(GameTime gameTime)
{
graphics.GraphicsDevice.Clear(Color.CornflowerBlue);
spriteBatch.Begin(this.camera);
// Draw here
spriteBatch.End();
base.Draw(gameTime);
}
```
## Draw
Through the `SpriteBatch` extension methods, simply call `Begin` as usual, but with your camera :
```csharp
spriteBatch.Begin(this.camera);
```
You can add a parralax factor too :
```csharp
spriteBatch.Begin(this.camera, new Vector2(0.85f,0.85f));
```
## Animations
You can add animation by applying [Transform](https://www.github.com/aloisdeniel/Transform) velocities or tweens onto the the camera's `Transform` property.
## Conversion
You can convert a point from screen unit to world :
```csharp
var screenPosition = Vector.Zero;
var worldPosition = Vector.Zero;
camera.ToWorld(ref screenPosition, out worldPosition);
```
Converting world coordinates to screen coordinates is also possible.
```csharp
var screenPosition = Vector.Zero;
var worldPosition = Vector.Zero;
camera.ToScreen(ref worldPosition, out screenPosition);
```
## Debug tools
The framework provide several tools for debugging purpose.
```csharp
camera.Debug.IsVisible = Keyboard.GetState().IsKeyDown(Keys.F1);
```
Make sure to load content too :
```csharp
this.camera.LoadContent(GraphicsDevice);
```
And then draw it with `Draw` extension method. You don't have to call `spriteBatch.Begin` and `spriteBatch.End` which are already invoked by the method.
```csharp
this.spriteBatch.Draw(this.camera.Debug);
```
### FPS
The number of frame per seconds will be displayed on the layer.
### Grid
A visual grid for world units.
```csharp
// To draw a white line of size 2 every 50 world units
// and a red one of size 4 every 200 world units.
camera.Debug.Grid.AddLines(50, Color.White, 2);
camera.Debug.Grid.AddLines(200, Color.Red, 4);
```
## Roadmap / Ideas
* Integrate shaders for easy screen effects.
* Add more built-in animations.
* Clean and improve debug layer.
## Why?
"Seriously, just a camera ?" ... Yes! I often see full engines with tons of stuff I never need. I'm looking about modularity and easy APIs (like many awesome [LÖVE](https://love2d.org/) libraries) and that's why I created **Comora**. I'm sure this could be useful for someone else.
## Thanks
* [david-gouveia](http://www.david-gouveia.com/portfolio/2d-camera-with-parallax-scrolling-in-xna/)
* [Monogame.Extended](https://github.com/craftworkgames/MonoGame.Extended)
## Contributions
Contributions are welcome! If you find a bug please report it and if you want a feature please report it.
If you want to contribute code please file an issue and create a branch off of the current dev branch and file a pull request.
### License
MIT © [Aloïs Deniel](http://aloisdeniel.github.io)