-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from gopxl/dev
v1.0.0 Release PR
- Loading branch information
Showing
222 changed files
with
10,500 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
# Contributing to Pixel | ||
|
||
:tada: Hi! I'm really glad you're considering contributing to Pixel! :tada: | ||
:tada: Hi! I'm really glad you're considering contributing to Pixel2! :tada: | ||
|
||
## Here are a few ways you can contribute | ||
|
||
1. **Make a community example** and place it inside the `community` folder of the [examples repository][examples]. | ||
2. **Add tests**. There only few tests in Pixel at the moment. Take a look at them and make some similar. | ||
3. **Add a small feature or an improvement**. Feel like some small feature is missing? Just make a PR. Be ready that I might reject it, though, if I don't find it particularly appealing. | ||
3. **Add a small feature or an improvement**. Feel like some small feature is missing? Make a PR and let's discuss it! | ||
4. **Join the big development** by joining the discussion on our [Discord Server](https://discord.gg/q2DK4MP), where we can discuss bigger changes and implement them after that. | ||
|
||
## How to make a pull request | ||
|
||
Go gives you a nice surprise when attempting to make a PR on Github. The thing is, that when user _xyz_ forks Pixel on Github, it ends up in _github.com/xyz/pixel_, which fucks up your import paths. Here's how you deal with that: https://www.reddit.com/r/golang/comments/2jdcw1/how_do_you_deal_with_github_forking/. | ||
Go gives you a nice surprise when attempting to make a PR on Github. The thing is, that when user _xyz_ forks Pixel on Github, it ends up in _github.com/xyz/pixel_, which conflicts with your import paths. Here's how you deal with that: https://www.reddit.com/r/golang/comments/2jdcw1/how_do_you_deal_with_github_forking/. | ||
|
||
[examples]: https://github.com/faiface/pixel-examples/tree/master/community | ||
[examples]: https://github.com/gopxl/pixel/tree/master/examples/community |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 Michal Štrba | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## Pixel 2 Examples | ||
|
||
This repository contains a few examples demonstrating [Pixel2](https://github.com/gopxl/pixel)'s functionality. | ||
|
||
**To run an example**, navigate to its directory, then `go run` the `main.go` file. For example: | ||
|
||
``` | ||
$ cd platformer | ||
$ go run main.go | ||
``` | ||
|
||
Here are some screenshots from the examples! | ||
|
||
| [Lights](lights) | [Platformer](platformer) | | ||
| --- | --- | | ||
| ![Lights](lights/screenshot.png) | ![Platformer](platformer/screenshot.png) | | ||
|
||
| [Smoke](smoke) | [Typewriter](typewriter) | | ||
| --- | --- | | ||
| ![Smoke](smoke/screenshot.png) | ![Typewriter](typewriter/screenshot.png) | | ||
|
||
| [Raycaster](community/raycaster) | [Starfield](community/starfield) | | ||
| --- | --- | | ||
| ![Raycaster](community/raycaster/screenshot.png) | ![Starfield](community/starfield/screenshot.png) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
OUT := amidakuji | ||
ASSET_TARGET := glossary/asset.go | ||
ASSET_SOURCE_DIR := assets | ||
VERSION := $(shell git describe --always --long) | ||
PKG_LIST := $(shell go list ./... | grep -v /vendor/) | ||
GO_FILES := $(shell find . -name '*.go' | grep -v /vendor/) | ||
|
||
all: build build_windows | ||
|
||
${ASSET_TARGET}: | ||
go-bindata -o "${ASSET_TARGET}" -pkg "glossary" -prefix "${ASSET_SOURCE_DIR}" ${ASSET_SOURCE_DIR}/emoji ${ASSET_SOURCE_DIR}/karaoke ${ASSET_SOURCE_DIR}/NanumBarunGothic.ttf | ||
|
||
build: ${ASSET_TARGET} | ||
go build -i -v -o ${OUT} -ldflags "-w -s -X main.version=${VERSION}" | ||
|
||
build_windows: ${ASSET_TARGET} | ||
go build -i -v -o ${OUT}.exe -ldflags "-w -s -X main.version=${VERSION} -H windowsgui" | ||
|
||
run: build | ||
./${OUT} | ||
|
||
test: | ||
@go test -short ${PKG_LIST} | ||
|
||
vet: | ||
@go vet -copylocks=false ${PKG_LIST} | ||
|
||
vet_annoying: | ||
@go vet ${PKG_LIST} | ||
|
||
lint: | ||
@for file in ${GO_FILES} ; do \ | ||
golint $$file ; \ | ||
done | ||
|
||
#static: vet lint | ||
# go build -i -v -o ${OUT}-${VERSION} -ldflags "-extldflags \"-static\" -w -s -X main.version=${VERSION}" | ||
|
||
#static_windows: vet lint | ||
# go build -i -v -o ${OUT}-${VERSION}.exe -ldflags "-extldflags \"-static\" -w -s -X main.version=${VERSION} -H windowsgui" | ||
|
||
clean: | ||
-@rm ${ASSET_TARGET} ${OUT} ${OUT}.exe #${OUT}-* | ||
|
||
.PHONY: build build_windows run vet vet_annoying lint clean |
Oops, something went wrong.