Git Product home page Git Product logo

fossy's Introduction

Fossy

Fossy is... Well, it doesn't really know what it is. But it's alive now, that's for sure. It can do things, like move, eat, and sleep. It can interact with it's environment. It can create.

But it's not all rainbows and butterflies. Fossy's world is beautiful but mysterious, plentiful but dangerous. To survive, it will take more than just being alive.

But not to fear, Fossy is not alone in this world. There are bountiful creatures in this world, each with their own incredible abilities and talents. And just maybe, with a common goal and a dash of trust, you can help each other achieve more than you ever could alone.

Journey on a path of self-discovery through a procedural open world of ancient natural beauty, a unique virtual ecosystem where anything is possible. Find friends in creatures with common goals, and work together to keep each other alive and safe. But watch out! Unspeakable dangers lurk in the night, And failing to find shelter could mean the end of your journey...

Overview

Fossy is a project that aims to showcase the power of open-source development in the gaming industry. The game itself teaches the core lesson of free and open source, and the reason behind the project: "Teamwork makes the dream work". There is always someone with common interests and goals, but everyone has different talents and specialties. When we complement each other by contributing to the group, we can get so much farther together than we ever could apart.

Technically, the end goal for the project is to get a contributor who is attracted to the project by the game itself, instead of the GitHub or website. They enjoy playing the game, and want to help out in it's development. Of course, we need a playerbase first, and so the goal right now is to publish a stable 0.1.0 release as an early access game on Steam.

But, Just like Fossy, I can't do this alone. I need YOU! You have talents that are different than mine, which means anything you do to help, you are doing better than me. If this project sounds exciting, I encourage you to help! Follow the instructions below to download and play the game, then come back here to the Issues page to suggest changes or improvements to the game.

Download the game

I don't have CI/CD checks or nightly build artifacts set up yet, and there are no releases until the betas, so you currently have to build from source.

Build the game

Run the game

fossy's People

Contributors

thedocruby avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

fossy's Issues

[Design]: Character sprite currently uses a placeholder

Prerequisites

Summary

Player character sprite currently uses assets/textures/icon.png as a placeholder.

Potential Solution

Design and utilize a character sprite for Fossy (player character). Should be a pixel sprite, probably between 8x8 and 64x64. Exact dimensions are up in the air. No guarantee that this will be the final character model. Provide reasons for any stylistic choices made, if possible.

Media

Current sprite (placeholder)
assets/textures/icon.png

In which category does the issue belong?

Feature ๐Ÿ†• - A new feature.

[Backend]: Add contribution guidelines

Prerequisites

  • I have read the Git Etiquette. (Required)
  • I agree to follow the Code of Conduct. (Required)
  • Are you intending to include tests? (Optional)

Summary (Required)

Add contribution guidelines and implement.

Potential Solution (Required)

Adapt https://github.com/nergster/Git-Etiquette to a more contributor-friendly format, and add to the repo as CONTRIBUTING.md. Reference this file in issue templates etc. in place of Git Etiquette and Code of Conduct.

In which category does the issue belong? (Required)

Meta ๐Ÿ‘จโ€๐Ÿ’ป - Changes development files, but not product code (e.g. changes to .gitignore, workflows, readme...).

[Frontend]: Rendering not properly set up.

Prerequisites

Summary

The rendering pipeline is not properly set up for fixed-resolution pixel rendering on higher resoultion screens (e.g. 144p fullscreen on 1080p monitor just renders in 1080p)

Potential Solution

Prepare the rendering pipeline with a fixed-size low-res render buffer, upscaled as needed to be more visible on high-definition displays

In which category does the issue belong?

Feature ๐Ÿ†• - A new feature.

[Backend]: Add source

Prerequisites

  • I have read the Git Etiquette. (Required)
  • I agree to follow the Code of Conduct. (Required)
  • Are you intending to include tests? (Optional)

Summary (Required)

Missing source

Potential Solution (Required)

Add source

In which category does the issue belong? (Required)

Feature ๐Ÿ†• - A new feature.

[Backend]: Add build instructions

Prerequisites

Summary

CONTRIBUTING.md and README.md do not include the steps needed to build and contribute to the project.

Potential Solution

Add instructions for cloning, building, running, etc. to the appropriate sections in CONTRIBUTING.md and README.md

In which category does the issue belong?

Meta ๐Ÿ‘จโ€๐Ÿ’ป - Changes development files, but not product code (e.g. changes to .gitignore, workflows, readme...).

[Backend]: CI/CD workflow automation for tests

Prerequisites

Summary

Add workflows to the repo to manage automated tests for PRs.

Potential Solution

Use the builtin Rust workflow, and add tests to cargo

In which category does the issue belong?

Meta ๐Ÿ‘จโ€๐Ÿ’ป - Changes development files, but not product code (e.g. changes to .gitignore, workflows, readme...).

[Backend]: Workflows need to be revised

Prerequisites

  • I have read the Git Etiquette. (Required)
  • I agree to follow the Code of Conduct. (Required)
  • Are you intending to include tests? (Optional)

Summary (Required)

Workflows can be better
(I should elaborate here but I won't)

Potential Solution (Required)

Improve workflows
(I should elaborate here but I won't)

Media (Optional)

No response

In which category does the issue belong? (Required)

Meta ๐Ÿ‘จโ€๐Ÿ’ป - Changes development files, but not product code (e.g. changes to .gitignore, workflows, readme...).

[Backend]: Workflows are untested and possibly broken

Prerequisites

  • I have read the Git Etiquette. (Required)
  • I agree to follow the Code of Conduct. (Required)
  • Are you intending to include tests? (Optional)

Summary (Required)

Creating Issue etc. to test workflow

Potential Solution (Required)

This issue (and the linked PR, if any) is the potential solution

In which category does the issue belong? (Required)

Meta ๐Ÿ‘จโ€๐Ÿ’ป - Changes development files, but not product code (e.g. changes to .gitignore, workflows, readme...).

[Frontend]: Website

Prerequisites

Summary

Add a website for the project to increase awareness.

Potential Solution

Add a /pages folder set up for use with Github Pages themes.

In which category does the issue belong?

Meta ๐Ÿ‘จโ€๐Ÿ’ป - Changes development files, but not product code (e.g. changes to .gitignore, workflows, readme...).

[Backend]: Readme is out of date

Prerequisites

  • I have read the Git Etiquette. (Required)
  • I agree to follow the Code of Conduct. (Required)
  • Are you intending to include tests? (Optional)

Summary (Required)

README.md is out of date.

Potential Solution (Required)

Update README

In which category does the issue belong? (Required)

Meta ๐Ÿ‘จโ€๐Ÿ’ป - Changes development files, but not product code (e.g. changes to .gitignore, workflows, readme...).

[Backend]: Linked PRs are not tracked by the workflow

Prerequisites

Summary (Required)

Linked PRs are not tracked by the workflow. This causes gaps in automation between the Backlog ๐Ÿ“œ and In Progress ๐Ÿ› ๏ธ statuses. In these cases, In Progress ๐Ÿ› ๏ธ must be added manually when the PR is linked.

In addition, All PR's should be linked, even though outside contributors have no means to do this.

Potential Solution (Required)

Add a workflow job for the connected Issue event type that changes the labels and status of the issue to In Progress ๐Ÿ› ๏ธ.

In addition, add an Unlinked โ›“๏ธ Flag label that is added to new Pull Requests, so that contributors and organization members can address these as soon as possible.

It would also be a good idea to explore keyword linking.

In which category does the issue belong? (Required)

Meta ๐Ÿ‘จโ€๐Ÿ’ป - Changes development files, but not product code (e.g. changes to .gitignore, workflows, readme...).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.