Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Wiki #122

Open
PopeSpaceous opened this issue Nov 1, 2018 · 12 comments
Open

Update Wiki #122

PopeSpaceous opened this issue Nov 1, 2018 · 12 comments

Comments

@PopeSpaceous
Copy link
Owner

Update Wiki:
Testing Documentation: How to test
Contributing: Details on how to contribute
Setting up Development Environment: Which Unity versions are supported currently
Creating Assets: How to, guides and Info. Sprite Sheets, How to use Gimp for pixel art, Animation tree info

@saketepe
Copy link
Contributor

saketepe commented Nov 6, 2018

if you can teach me i can do this. My understanding is just to download unity, then this repo and edit the files there.

@saketepe
Copy link
Contributor

saketepe commented Nov 6, 2018

Where is the wiki, do i need to create one?

@PopeSpaceous
Copy link
Owner Author

@saketepe https://github.com/PopeSpaceous/Solitary/wiki

Let me know if you cannot access it and I'll check the permissions on it.
Thanks 👍

@saketepe
Copy link
Contributor

saketepe commented Nov 6, 2018 via email

@PopeSpaceous
Copy link
Owner Author

Ok Can you check it again and if you get in please test adding/ editing.
Thanks @saketepe

@saketepe
Copy link
Contributor

saketepe commented Nov 8, 2018

Hey, do you have a tot for how to install and test the code, rn i only have outlines

@PopeSpaceous
Copy link
Owner Author

We're working on a readme. Just trying to merge contributes branch. Will message you when its finished :)

@PopeSpaceous
Copy link
Owner Author

Hi, It's not merged yet, but you can see @Dragomegak 's updated readme, with contributing.
Dragomegak's Repo
If you can research and get playtest documentation on how to playtest it, that would be awesome!

@PopeSpaceous
Copy link
Owner Author

@saketepe We have updated the Readme for more instructions on setup, contributing etc.
Please have a look, and let me know if you have any questions.
Thanks!

@saketepe
Copy link
Contributor

Hey what are your plans for there wiki? Do you want me to create a clone of the readme files, but on wiki or do you want to just link to the readme pages? Or do you want there to be something else in the wiki

@PopeSpaceous
Copy link
Owner Author

You could add, how to play, helpful hints. A guide to play testing (this may need some research to make a guide). And a link to the readme and contributions.

You could also find some tutorials or guides for coding in unity as resource links.

Here's what we had when playtesting. It's very rudimentary:
Instructions for Testing
Starting the Game:
To run the game, open up the downloaded Solitary folder, and click on Solitary.exe (see image below)
 
Controls:
Use either the left and right arrow keys or the ‘a’ and ‘d’ keys to move the character left and right respectively.  
Press ‘e’ to interact with in game objects like (puzzles, computers, doors, and ladders)

If you find a bug, or error:
Open the bug report document located in the same folder. 
For severity: 
•	High: If the game crashes or it causes you to not be able to play the game
•	Medium: If there is a bug that doesn’t break the game but makes the game not enjoyable to play
•	Low:  Minor bug. Doesn’t affect gameplay. Or a cosmetic issue

Steps to reproduce: 
In order to fix an issue, we have to be able to see it ourselves. Try to reproduce the bug and what steps you did to cause it

Expected Results vs Actual Results
An Expected vs Actual result would be something like:
Ex. Jumping off a platform onto the ground. Expected: Player stops vertical movement when they reach the floor. Actual: Player continues through floor and clips through it. 

Images:
A picture is worth a 1000 words. (A video is worth even more)
If possible attach a picture of the bug to the report. This greatly helps the debugging and patching of the game. Use the link for instructions on how to use the Windows Snipping Tool.

@saketepe
Copy link
Contributor

saketepe commented Nov 15, 2018 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants