Skip to content

Commit

Permalink
Merge branch 'latest' of github.com:vuelto-org/vuelto into latest
Browse files Browse the repository at this point in the history
  • Loading branch information
dimkauzh committed Dec 14, 2024
2 parents 916f046 + 7236b4e commit 9f0f46a
Show file tree
Hide file tree
Showing 49 changed files with 256 additions and 200 deletions.
8 changes: 4 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

Vuelto is built by developers, for developers. We are committed to fostering a welcoming and inclusive community. By participating in this project, you agree to the following principles:

1. **Respect Everyone**
1. **Respect Everyone**
Treat all contributors with kindness and respect. Discrimination, harassment, or offensive language is not tolerated.

2. **Collaborate Openly**
2. **Collaborate Openly**
Share ideas, feedback, and code in a constructive and respectful manner. Assume good intentions and work to resolve disagreements with empathy.

3. **Stay Professional**
3. **Stay Professional**
Keep discussions focused on the project. Avoid disruptive behavior, spamming, or derailing conversations.

4. **Be Inclusive**
4. **Be Inclusive**
Make the community accessible to everyone, regardless of experience level, background, or identity.

Violations of this Code of Conduct may result in warnings, bans, or other actions as necessary. If you experience or witness any unacceptable behavior, please report it to the maintainers.
Expand Down
13 changes: 4 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Contributing rules

We are happy and welcome if you want to contribute to Vuelto. But please consider a few details before continuing:

1. Branch: Please when working on your fork, work in the dev branch, because we only will accept commits to the dev branch. It will later be released with the next version of Vuelto.
Expand All @@ -13,6 +14,7 @@ We allow you to re-open a new pull request, but we expect you to have your code
So make sure that you followed [the rules](#contributing-rules)

Some technologies we are using

- GLFW: We use this for the desktop windowing
- “syscall/js”: We use this to interact with the JS runtime
- glow: Generate OpenGL Go bindings (only happened one)
Expand All @@ -22,19 +24,12 @@ Some technologies we are using

If you want to contribute, you have to set up the work environment, so you can develop vuelto the right way.

1. Install the packages

```bash
go mod tidy
```

1. Run `go mod tidy` to install all the packages
2. Fork [the repository](https://github.com/vuelto-org/vuelto).

3. Clone your forked github repository:

```bash
git clone https://github.com/your_username_/vuelto.git
cd vuelto
git clone https://github.com/your_username/vuelto.git
```

4. Change the branch to the dev branch to follow rule \#1:
Expand Down
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<h1 align="center">Vuelto</h1>
<p align="center">
<img width="1400" alt="banner" src="https://github.com/vuelto-org/vuelto/raw/latest/logo/banner-dark.png#gh-dark-mode-only">
<img width="1400" alt="banner" src="https://github.com/vuelto-org/vuelto/raw/latest/logo/banner-light.png#gh-light-mode-only">
<a href="https://github.com/vuelto-org/vuelto"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/vuelto-org/vuelto?style=for-the-badge"></a>
<a href="https://github.com/vuelto-org/license"><img alt="License" src="https://img.shields.io/badge/license-VL--Cv1.1-blue?style=for-the-badge"></a>
<a href="https://github.com/vuelto-org/vuelto/actions/workflows/ci_check.yml">
<a href="https://github.com/vuelto-org/vuelto/actions/workflows/ci_check.yml">
<img alt="CI Check" src="https://img.shields.io/github/actions/workflow/status/vuelto-org/vuelto/ci_check.yml?style=for-the-badge">
</a>
<a href="https://github.com/vuelto-org/vuelto"><img alt="Lines of code" src="https://www.aschey.tech/tokei/github/vuelto-org/vuelto?style=for-the-badge"></a>
Expand All @@ -16,6 +15,7 @@
Vuelto is an open-source, fast, and lightweight game engine, based on Golang, CGo, and OpenGL. It's easy to use yet very powerful, and it's also cross platform, meaning it can be deployed on almost all major platforms

## ✨ Features

- 🌍 Cross Platform
- 🛠️ Open-Source
- 📚 Easy to learn
Expand All @@ -24,7 +24,9 @@ Vuelto is an open-source, fast, and lightweight game engine, based on Golang, CG
## 📦 Installation

### 📋 Requirements

You need to have the following installed on your system:

- 🖥️ A C compiler
- 🔧 A Go compiler
- 🪟 Xorg/Wayland development packages (For Linux only)
Expand All @@ -35,6 +37,7 @@ For an installation guide, [go here](https://vuelto.pp.ua/install/).
### 🐹 Go package

You can get the latest Go package by running this command:

```sh
go get vuelto.pp.ua@latest
```
Expand All @@ -45,21 +48,21 @@ go get vuelto.pp.ua@latest
package main

import (
vuelto "vuelto.pp.ua/pkg"
vuelto "vuelto.pp.ua/pkg"
)

func main() {
w := vuelto.NewWindow("Image Example - Vuelto", 800, 600, false)
ren := w.NewRenderer2D()
w := vuelto.NewWindow("Image Example - Vuelto", 800, 600, false)
ren := w.NewRenderer2D()

image := ren.LoadImage("test/image.png", 300, 300, 250, 250)
image1 := ren.LoadImage("test/image.png", 100, 100, 150, 150)
image := ren.LoadImage("test/image.png", 300, 300, 250, 250)
image1 := ren.LoadImage("test/image.png", 100, 100, 150, 150)

for !w.Close() {
image.Draw()
image1.Draw()
w.Refresh()
}
for !w.Close() {
image.Draw()
image1.Draw()
w.Refresh()
}
}
```

Expand Down Expand Up @@ -107,7 +110,7 @@ If you find a security vulnerability, please follow the instructions in [SECURIT

### 🔐 License

Vuelto is licensed under the [VL-Cv1.1 Licence](LICENSE.md). Any PRs that will change the license won't be accepted.
Vuelto is licensed under the [VL-Cv1.1 License](LICENSE.md). Any PRs that will change the license won't be accepted.

### 📖 Guidelines

Expand All @@ -126,14 +129,13 @@ You can contact us via our Discord community or at our email:
### 🙌 Thanks To

A special thanks to:

- **Dimkauzh** for the initial idea and development.
- **ZakaHaceCosas** for the great improvements on top of vuelto.

Without your help, Vuelto wouldn't be where it is today. 🙌

Also a big shoutout to our homies and partners at [**Sokora**](https://sokora.org), [**Atom**](https://atomlabs.ie) and [**Epic-Bot**](https://bamb.cl/epic-bot/)

Your support has helped make Vuelto even better! 🤝
Without the help of these people, Vuelto wouldn't be where it is today. Your support has helped make Vuelto even better! 🤝 🙌

---

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vuelto Security Policy

## Reporting security vulnerabilites
## Reporting security vulnerabilities

If you find a security issue with Vuelto, we please ask you that you contact us privately via [email](mailto:[email protected]) instead of making a public issue / PR, so we can fix it as soon as possible without drawing unwanted attention. You will receive a response as soon as we can, and you'll be notified and accordingly credited as we release a patch.

Expand Down
2 changes: 1 addition & 1 deletion internal/gl/legacy/legacy.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/gl/opengl.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/gl/shader.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/gl/shader/loader.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/gl/webgl.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/gl/webgl/binding.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/image/image_go.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/trita/type.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/cocoa/cocoa.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/wayland/wayland.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/web/canvas.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/web/document.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/web/window.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/win32/win32.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/win_glfw.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/win_web.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion internal/window/x11/x11.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ nav:
- Home: "index.md"
- Getting started:
- 🚀 Quick start: "get-started.md"
- 🛠️ Indepth Installation: "install.md"
- 🛠️ In-depth Installation: "install.md"

- Docs:
- 🏠 Home: "docs/index.md"
Expand Down
2 changes: 1 addition & 1 deletion pkg/audio.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion pkg/draw.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion pkg/image.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion pkg/renderer.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion pkg/shapes.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion pkg/vectors.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
2 changes: 1 addition & 1 deletion pkg/window.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright (C) 2024 vuelto-org
*
* This file is part of the Vuelto project, licensed under the Vuelto License V1.
* This file is part of the Vuelto project, licensed under the VL-Cv1.1 License.
* Primary License: GNU GPLv3 or later (see <https://www.gnu.org/licenses/>).
* If unmaintained, this software defaults to the MIT License as per Vuelto License V1,
* at which point the copyright no longer applies.
Expand Down
Loading

0 comments on commit 9f0f46a

Please sign in to comment.