mirror of
https://github.com/bloeys/nmage.git
synced 2025-12-29 13:28:20 +00:00
Update readme
This commit is contained in:
22
README.md
22
README.md
@ -1,5 +1,23 @@
|
||||
# nMage
|
||||
|
||||
## GLSL Linter
|
||||
nMage is a (hopefully!) high performance 3D Game Engine written in Go being developed [live](https://twitch.tv/bloeys), with recording posted on [YouTube](https://www.youtube.com/channel/UCCf4qyNGPVwpj1HYFGahs_A).
|
||||
|
||||
For the linter to work shaders must be `*.vert, *.frag etc...` or `*.vert.glsl, *.frag.glsl etc...`.
|
||||
This project is being built with the goals being (in no particular order):
|
||||
|
||||
* Sharing knowledge about less popular/less taught (e.g. compared to web dev), yet very powerful computing topics by building things and explaining as we go
|
||||
* Showing the development process of large, high performance software, including things like: learning unfamiliar topics, reading docs, fixing bugs and profiling and optimizing
|
||||
* To build a good game engine that can actually be used to develop games
|
||||
* Have fun through the entire thing!
|
||||
|
||||
## Running the code
|
||||
|
||||
To run the project you need:
|
||||
|
||||
* A recent version of [Go](https://golang.org/) installed
|
||||
* A C/C++ compiler installed and in your path
|
||||
* Windows: [MingW](https://www.mingw-w64.org/downloads/#mingw-builds) or similar
|
||||
* Mac/Linux: Should be installed by default, but if not try [GCC](https://gcc.gnu.org/) or [Clang](https://releases.llvm.org/download.html)
|
||||
|
||||
Then simply clone and use `go run .`
|
||||
|
||||
> Note: that it might take a while to run the first time because of downloading/compiling dependencies.
|
||||
|
||||
2
main.go
2
main.go
@ -31,7 +31,7 @@ func main() {
|
||||
logging.ErrLog.Fatalln("Failed to init SDL. Err:", err)
|
||||
}
|
||||
|
||||
window, err = sdl.CreateWindow("Go SDL Engine", sdl.WINDOWPOS_CENTERED, sdl.WINDOWPOS_CENTERED, winWidth, winHeight, sdl.WINDOW_OPENGL)
|
||||
window, err = sdl.CreateWindow("Go SDL Engine", sdl.WINDOWPOS_CENTERED, sdl.WINDOWPOS_CENTERED, winWidth, winHeight, sdl.WINDOW_OPENGL|sdl.WINDOW_RESIZABLE)
|
||||
if err != nil {
|
||||
logging.ErrLog.Fatalln("Failed to create window. Err: ", err)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user