Skip to content

Commit

Permalink
docs: Update README with contributing information, progress and roadm…
Browse files Browse the repository at this point in the history
…ap notes, and new workflow badges

ci: Skip publish workflow if the version doesn't change
  • Loading branch information
IanTapply22 committed May 25, 2024
1 parent 88dd292 commit d71e11b
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 28 deletions.
38 changes: 29 additions & 9 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,54 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# GitHub recommends pinning actions to a commit SHA.
# To get a newer version, you will need to update the SHA.
# You can also reference a tag or branch, but the action may change without warning.

name: Publish package to GitHub Packages

on:
push:
branches: [ "main" ]

jobs:
version:
runs-on: ubuntu-latest
outputs:
version: ${{ steps.version.outputs.version }}
steps:
- uses: actions/checkout@v2
- uses: thecodemonkey/action-get-gradle-version@master
id: version
- run: 'echo version ${{ steps.version.outputs.version }}'

publish:
needs: version
runs-on: ubuntu-latest
permissions:
contents: read
packages: write

steps:
- uses: actions/checkout@v4

- uses: actions/setup-java@v4
with:
java-version: '21'
distribution: 'temurin'

- name: Setup Gradle
uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0

- name: Compare with published version
id: compare_versions
run: |
PUBLISHED_VERSION=$(curl -s \
-u ${{ secrets.GITHUB_USERNAME }}:${{ secrets.GITHUB_TOKEN }} \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/${{ github.repository }}/packages/gradle/${{needs.version.outputs.version}})
if [[ "$PUBLISHED_VERSION" == *"${{needs.version.outputs.version}}"* ]]; then
echo "Version is already published. Skipping publish step."
exit 0
else
echo "Version not published. Proceeding with publish step."
fi
- name: Publish package
if: steps.compare_versions.outputs.skip != 'true'
run: ./gradlew publish
env:
GITHUB_USERNAME: IanTapply22
Expand Down
Empty file added CONTRIBUTING.md
Empty file.
28 changes: 9 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,13 @@
<br>
Great question! This repository does not contain a license at this point of time because of the fact that this is a recreation of the Wynncraft core functionality. I **did not** create the ideas or aspects of the actual server and I wish to give all credit to the developers of Wynncraft when possible.

## Remaining Plugin Modules/Features
Most of the remaining features/modules have documentation attached to them. All modules and features have a number in brackets on the far right, this is to signify the priority of each task. The following is a list of features that are yet to be implemented:
## Roadmap and Progress
Aren't sure when a new release will be published or what's planned for this project? Please see the [Project Board/Planner](https://github.com/users/IanTapply22/projects/8) to view the progress, roadmap, backlog, and reported bugs associated with the project. The board is updated frequently and is the go-to place to view the status of this project.

- [ ] Quests (https://wynncraft.fandom.com/wiki/Quests) (8)
- [ ] Dungeons (https://wynncraft.fandom.com/wiki/Dungeons) (15)
- [ ] Custom item system/builder (https://wynncraft.fandom.com/wiki/Category:Items) (3)
- [ ] Professions (both crafting and gathering professions) (https://wynncraft.fandom.com/wiki/Professions) (9)
- [ ] Guilds (guild territories, guild wars, etc.) (https://wynncraft.fandom.com/wiki/Guilds) (14)
- [ ] Trading (player to player) (https://wynncraft.fandom.com/wiki/Trading) (11)
- [ ] Chat system implementation (rank displays, party chat, etc.) (5)
- [ ] Wynncraft NPC system (https://wynncraft.fandom.com/wiki/Category:NPCs) (7)
- [ ] Custom entity builders/implementation (https://wynncraft.fandom.com/wiki/Mobs) (6)
- [ ] Wynncraft GUI system (1)
- [ ] Resources collection (wood, mining, fishing, etc.) (https://wynncraft.fandom.com/wiki/Category:Professions) (10)
- [ ] General command system (G.C.S) (https://wynncraft.fandom.com/wiki/Commands) (2)
- [ ] Wynncraft Horses (https://wynncraft.fandom.com/wiki/Horses) (4)
- [ ] Classes (https://wynncraft.fandom.com/wiki/Classes) (12)
- [ ] Cutscene manager (13)
- [ ] Experience system (https://wynncraft.fandom.com/wiki/Experience_Points) (8)
- [ ] **TIE EVERYTHING TOGETHER INTO THE CORE** (each module is a separate package, this is just a reminder to tie everything together and actually create functionality) (16)
## Contributing
The Wynncraft open-source project is open to contributions from anyone. If you wish to contribute to the project, please see the [CONTRIBUTING.md]() file for more information on how to contribute to the project.
<br>
Some ways to contribute to the project include:
- Reporting bugs or issues to our [Issue Tracker](https://github.com/IanTapply22/Wynncraft/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
- Contributing to the evolving [Wiki](https://github.com/IanTapply22/Wynncraft/wiki)
- Submitting a request for a missing feature or enhancement, or even by creating a [pull request](https://github.com/IanTapply22/Wynncraft/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) with the feature or bug fix

0 comments on commit d71e11b

Please sign in to comment.