Skip to content

FGA-GCES/Jogo-Unity-BOSS

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

🎮 Diários de Sofia

Jogo educacional mobile open source sobre inclusão no ensino superior

Unity · Open Source · Educação · Diversidade · Mobile

Made with Unity Open Source Mobile Ready Educational

🎮 Jogar👩‍💻 Contribuir📚 Documentação🎯 Good First Issues


📖 Sobre o Jogo

Na cidade de Ogama, as mulheres não têm direito ao ensino superior. Sofia, uma jovem inconformada com essa realidade, embarca em uma jornada para questionar as regras estabelecidas e lutar pelo seu direito à educação.

"Diários de Sofia" é um jogo narrativo 2D que combina:

  • 🎭 Storytelling envolvente sobre inclusão educacional
  • 🎮 Gameplay mobile-first com mecânicas acessíveis
  • 🎓 Objetivo educacional de promover discussões sobre diversidade
  • 🌟 Desenvolvimento aberto e colaborativo

📱 Saiba mais sobre o jogo →

📁 Estrutura da Documentação

docs/
├── index.md                      # 🏠 Landing page da documentação
├── jogo/                         # 🎮 Documentação do jogo
│   ├── game.md                   # Sobre o jogo e requisitos
│   ├── scripts.md                # Arquitetura e sistemas
│   ├── good_issues.md            # First good issues para novos contribuidores
│   ├── backlog.md                # Backlog e funcionalidades
│   └── clean_code.md             # Padrões de código
├── projeto/                      # 📋 Gestão do projeto
│   ├── concepts.md               # Conceitos e metodologia
│   ├── devprocess.md             # Processo de desenvolvimento
│   ├── sprints.md                # Planejamento de sprints
│   └── releases/                 # Documentação das releases
├── tutoriais/                    # 📚 Tutoriais Unity for Women
├── CONTRIBUTING.md               # 🤝 Guia de contribuição
├── CODE_OF_CONDUCT.md            # 📜 Código de conduta
├── ONBOARDING.md                 # 🚀 Onboarding para novos membros
└── checklist_oss.md              # ✅ Checklist open source

🚀 Como rodar a documentação localmente

Siga este passo a passo para rodar a documentação do projeto na sua máquina local usando o MkDocs com o tema Material for MkDocs.


🧰 Pré-requisitos

Antes de tudo, você precisa ter o seguinte instalado:

Verifique se estão instalados com:

python3 --version
pip3 --version
mkdocs --version
pip show mkdocs-material

🚀 Rodando localmente

Se for a primeira vez, execute:

mkdocs build

Logo depois, você pode rodar o servidor localmente usando:

mkdocs serve

Ele irá rodar em: http://localhost:8000

O servidor atualiza automaticamente a documentação sempre que você salva alterações nos arquivos .md.

🌍 Sobre Nós

É uma iniciativa aberta que combina:

  • 🎮 "Diários de Sofia": Jogo narrativo 2D
  • 🛠️ Workshop "Unity for Women": Tutoriais gratuitos para iniciantes em Unity, com foco em inclusão de mulheres na tecnologia.

🚀 Comece Aqui

Projeto Descrição Links Úteis
Jogo Na cidade de Ogama, as coisas são como são e ninguém discorda de nenhuma das regras. A principal delas: mulheres não têm direito ao ensino superior. Para Sofia, isso sempre foi motivo de incômodo, mas nunca viu ninguém ao seu redor lutar para que algo diferente aconteça. Documentação
Workshop Aprenda Unity do zero criando um jogo 2D passo a passo. Tutoriais
Roadmap
Glossário

👩‍💻 Participe

Como contribuir com o jogo Diários de Sofia

Você pode contribuir com o jogo Diários de Sofia de várias maneiras, como reportando bugs, sugerindo melhorias ou até mesmo contribuindo com código. Para começar, você precisará estar em conformidade com os Guias de Conduta e Contribuição do projeto.

Instalação do Jogo

🧰 Pré-requisitos

Certifique-se de ter o seguinte instalado:

Caso não tenha o Unity Hub instalado, siga as instruções de instalação no site oficial da Unity.

Após instalar o Unity Hub, você precisará adicionar a versão do Unity que será utilizada no projeto. Para isso, siga os passos abaixo:

  1. Abra o Unity Hub.
  2. Vá para a aba "Installs" (Instalações).
  3. Clique em "Add" (Adicionar) e selecione a versão 2022.3.20f1.
  4. Certifique-se de incluir os módulos necessários, como suporte ao Android e iOS, considerando que o intuito do jogo é rodar em dispositivos mobile. Não se preocupe, você poderá rodar o jogo no computador também.

Rodando localmente

Para rodar o jogo localmente, siga os seguintes passos:

  1. Clone o repositório do jogo:
git clone https://github.com/FGA-GCES/Jogo-Unity-BOSS.git
  1. Abra o Unity Hub.
  2. Vá para a aba "Projects" (Projetos).
  3. Clique em "Add" (Adicionar) e selecione a pasta do repositório clonado.
  4. Selecione o diretório "Unity-Project" e clique em "Open" (Abrir).
  5. O Unity irá carregar o projeto. Aguarde até que todos os pacotes sejam baixados e o projeto esteja pronto.

Compilação do Jogo

Para compilar o jogo, siga os seguintes passos:

  1. No Unity, vá para o menu "File" (Arquivo).
  2. Selecione "Build Settings" (Configurações de Compilação).
  3. Selecione a plataforma desejada (Android, iOS, PC, etc.).
  4. Clique em "Build" (Compilar) e escolha o local onde deseja salvar o arquivo compilado.
  5. Aguarde a compilação ser concluída. O Unity irá gerar o arquivo executável do jogo para a plataforma desejada.

Informações Adicionais

  • Atualmente, o jogo está em desenvolvimento, então cada cena pode conter elementos que ainda não estão finalizados. Sinta-se à vontade para explorar as cenas e contribuir com melhorias, correções de bugs ou novas funcionalidades.
  • Erros conhecidos na hora de rodar o jogo localmente podem ser encontrados na página de Erros Conhecidos.
  • Se quiser contribuir com o jogo, talvez seja interessante começar por uma GoodFirstIssue ou uma HelpWanted, que são issues mais fáceis de resolver e podem te ajudar a entender melhor o projeto. Você pode encontrar essas issues na página de Issues do repositório.
  • Para acessar as fases (cenas) disponíveis atualmente, você pode navegar até a pasta Assets/Scenes dentro do projeto Unity. Lá, você encontrará as cenas disponíveis para jogar e contribuir.
    1. Menu Principal: A cena inicial do jogo, onde você pode iniciar a jornada de Sofia e acessar as configurações.
    2. City Map: Mapa da cidade, onde poderá interagir com os NPCs e visitar outros locais.
    3. Library: A segunda fase do jogo, onde você continua a história de Sofia.
    4. SofiaHouse: Fase inicial do jogo, onde você conhece a casa de Sofia.

💬 Fale Conosco



Créditos



Protótipos do Figma


Feito com ❤️ para democratizar o desenvolvimento de jogos.


Licença

Este projeto está licenciado sob os termos da Licença MIT. Veja o arquivo LICENSE para mais detalhes.

Packages

No packages published

Languages

  • C# 69.5%
  • ShaderLab 19.3%
  • HTML 7.8%
  • HLSL 3.4%