{"id":21758483,"url":"https://github.com/skarlso/goprogressquest","last_synced_at":"2025-04-13T12:10:50.979Z","repository":{"id":57559586,"uuid":"45787612","full_name":"Skarlso/goprogressquest","owner":"Skarlso","description":"Progress Quest implemented in Go","archived":false,"fork":false,"pushed_at":"2018-09-29T20:29:56.000Z","size":5873,"stargazers_count":24,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T03:12:05.999Z","etag":null,"topics":["golang","progress-quest","rpg"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Skarlso.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-08T16:05:41.000Z","updated_at":"2023-03-24T12:35:41.000Z","dependencies_parsed_at":"2022-08-28T14:03:18.770Z","dependency_job_id":null,"html_url":"https://github.com/Skarlso/goprogressquest","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skarlso%2Fgoprogressquest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skarlso%2Fgoprogressquest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skarlso%2Fgoprogressquest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Skarlso%2Fgoprogressquest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Skarlso","download_url":"https://codeload.github.com/Skarlso/goprogressquest/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248710445,"owners_count":21149190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","progress-quest","rpg"],"created_at":"2024-11-26T11:21:54.185Z","updated_at":"2025-04-13T12:10:50.958Z","avatar_url":"https://github.com/Skarlso.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Coverage Status](https://coveralls.io/repos/github/Skarlso/goprogressquest/badge.svg?branch=master\u0026bust=1)](https://coveralls.io/github/Skarlso/goprogressquest?branch=master) [![Build Status](https://travis-ci.org/Skarlso/goprogressquest.svg?branch=master)](https://travis-ci.org/Skarlso/goprogressquest)\n\nGo Progress Quest\n=================\n\nThis will be a Go Implementation of the famous type of RPG, called:\nhttps://en.wikipedia.org/wiki/Progress_Quest\n\nSee it in action here:\n\n![GoProgressQuest](goprogress.gif)\n\nThis will be an API which can be consumed by any client in a number of ways.\n\nCLI Front-End for Go Progress Quest\n-----------------------------------\n\nThis is a very basic, semi interactive CLI front-end for this project:\n\n[GoProgressQuest Front-End](https://github.com/Skarlso/goprogressfrontend)\n\nExample usage\n-------------\n\n```bash\ncurl -H \"Content-type: application/json\" -X POST -d '{\"name\":\"awesome\"}' http://localhost:8989/api/1/create\ncurl -H \"Content-type: application/json\" -X POST -d '{\"name\":\"awesome\"}' http://localhost:8989/api/1/start\n```\n\nThis will start adventuring for character ```awesome```. Multiple characters can be sent adventuring. But after a while the log will be unreadable. Later, I might create a web front-end for this project which will be able to track multiple characters at once.\n\nAnd once you think your character adventured enough, simply call stop.\n\n```bash\ncurl -H \"Content-type: application/json\" -X POST -d '{\"name\":\"awesome\"}' http://localhost:8989/api/1/stop\n```\n\nInstalling\n==========\n\nGoProgressQuest uses mongodb for it's back-end storage. The storage medium is interfaced, so any kind of database can be plugged in and used if you implement these three functions:\n\n```go\n// Storage defines a storage medium. It could be anything that implements this interface.\ntype Storage interface {\n\tSave(Character) error\n\tLoad(string) (Character, error)\n\tUpdate(Character) error\n}\n```\n\nAPI\n===\n\nAPI Version is 1\n----------------\n\n/api/1/*\n\nThe following end-points are available:\n\nCreational\n----------\n\n```\n/\n```\nCurrently returns:\n```json\n{\n    \"message\":\"Welcome!\"\n}\n```\n\n```bash\n# Character names don't have to be unique\n/create\n```\n```json\nPOST:\n{\n    \"name\":\"MyAwesomeCharacterName\"\n}\n```\nReturn:\n```json\n{\n    \"name\":\"MyAwesomeCharacterName\"\n}\n```\n\n```bash\n# Load a character by ID since names are not unique at the moment\n/load/{ID}\n/load/3da541559918a808c2402bba5012f6c60b27661c\n```\n\nReturn:\n```json\n{\n    \"Inventory\":{\"Items\":[]},\"Name\":\"MyAwesomeCharacterName\",\"Stats\":{\"Str\":0,\"Agi\":0,\"In\":0,\"Per\":0,\"Chr\":0,\"Lck\":0},\"ID\":\"3da541559918a808c2402bba5012f6c60b27661c\",\"Gold\":0\n}\n```\n\nAdventuring related\n-------------------\n\n```bash\n# Start adventuring\n/start\n```\n\n```json\nPOST:\n{\n    \"name\":\"MyAwesomeCharacterName\"\n}\n```\nReturn:\n```json\n{\n    \"message\":\"Started adventuring for character: MyAwesomeCharacterName\"\n}\n```\n\n```bash\n# Stop adventuring\n/stop\n```\n```json\nPOST:\n{\n    \"name\":\"MyAwesomeCharacterName\"\n}\n```\nReturn:\n```json\n{\n    \"message\":\"Stopped adventuring for character: MyAwesomeCharacterName\"\n}\n```\n\nRunning it\n----------\n\n```bash\ngo build\n```\n\nCurrently the project is simple enough so that no Makefile is needed for this process.\n\nDependencies\n------------\n\nThis project uses [Glide](https://github.com/Masterminds/glide) as its package handler. Please add vendor and glide.lock to your ignore files. The project should always work with the latest versions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskarlso%2Fgoprogressquest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskarlso%2Fgoprogressquest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskarlso%2Fgoprogressquest/lists"}