$Atualizando o docs do repositório

SBD1 · Nov 28, 2024 · 46edcff · 46edcff
1 parent 367fdcd
commit 46edcff
Show file tree

Hide file tree

Showing 37 changed files with 460 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,23 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install mkdocs-material
+      - run: pip install pillow cairosvg
+      - run: mkdocs gh-deploy --force
diff --git a/docs/css/extra.css b/docs/css/extra.css
@@ -0,0 +1,53 @@
+/* Aplica justificação global ao conteúdo principal */
+.md-content {
+    text-align: justify;
+}
+
+/* Muda o fundo do header para preto */
+.md-header {
+    background-color: #000 !important;
+}
+
+/* Opcional: altera a cor do texto para melhorar o contraste */
+.md-header a {
+    color: #fff !important;
+}
+
+/* Muda o fundo da barra de navegação */
+.md-tabs {
+    background-color: #000 !important; /* Preto */
+}
+
+/* Opcional: altera a cor do texto dos itens da barra */
+.md-tabs a {
+    color: #fff !important; /* Branco */
+}
+
+/* Opcional: altera a cor do texto do item ativo */
+.md-tabs .md-tab--active a {
+    color: #ffcc00 !important; /* Amarelo */
+    font-weight: bold; /* Destacar o item ativo */
+}
+
+/* Opcional: remover borda ou alterar estilo */
+.md-tabs {
+    border-bottom: none !important;
+}
+
+
+.highlighted-text {
+/* Altere a cor conforme necessário */
+    font-weight: bold; /* Deixa o texto eX'm negrito */
+}
+
+/* CSS para rolagem horizontal em tabelas e código */
+.md-typeset table {
+    display: block;
+    overflow-x: auto;
+    white-space: nowrap;
+}
+
+.md-typeset pre {
+    overflow-x: auto;
+}
+
diff --git a/docs/entrega-1/Apresentação.md b/docs/entrega-1/Apresentação.md
@@ -0,0 +1,13 @@
+# <center>Apresentação</center>
+
+Segue abaixo a apresentação em vídeo do Trabalho 1, elabadorado pelo Grupo 8.
+
+#
+
+<center>
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/N8sSPf_GXVY?si=-8fE8Q6Bx5jae-Ov" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+
+[Link da apresentação](https://youtu.be/N8sSPf_GXVY)
+
+</center>
diff --git a/docs/entrega-1/DD.md b/docs/entrega-1/DD.md
@@ -0,0 +1,75 @@
+# <center>Entrega do Trabalho 1 - Modelagem</center>
+
+## **Dicionário de Dados**
+
+Dicionário de Dados é um registro detalhado que documenta os elementos de um banco de dados, como tabelas, colunas, tipos de dados e restrições. Ele é indispensável para garantir consistência, padronização e clareza, sendo utilizado como referência durante o desenvolvimento, manutenção e evolução do sistema.
+
+![cnpImg](../img/personagem_dd.png)
+
+
+![cnpImg](../img/pc_dd.png)
+
+
+![cnpImg](../img/npc_dd.png)
+
+
+![cnpImg](../img/inimigo_dd.png)
+
+
+![cnpImg](../img/instanciainimigo_dd.png)
+
+
+![cnpImg](../img/comerciante_dd.png)
+
+
+![cnpImg](../img/loja_dd.png)
+
+
+![cnpImg](../img/item_dd.png)
+
+
+![cnpImg](../img/coletavel_dd.png)
+
+
+![cnpImg](../img/equipamento_dd.png)
+
+
+![cnpImg](../img/armadura_dd.png)
+
+
+![cnpImg](../img/arma_dd.png)
+
+
+![cnpImg](../img/implantecibernetico_dd.png)
+
+
+![cnpImg](../img/instanciaitem_dd.png)
+
+
+![cnpImg](../img/inventario_dd.png)
+
+
+![cnpImg](../img/distrito_dd.png)
+
+
+![cnpImg](../img/celula_dd.png)
+
+
+![cnpImg](../img/classes_dd.png)
+
+
+![cnpImg](../img/origem_dd.png)
+
+
+![cnpImg](../img/faccao_dd.png)
+
+
+![cnpImg](../img/habilidade_dd.png)
+
+
+![cnpImg](../img/dialogo_dd.png)
+
+
+![cnpImg](../img/missao_dd.png)
+
+
diff --git a/docs/entrega-1/DER.md b/docs/entrega-1/DER.md
@@ -0,0 +1,9 @@
+# <center>Entrega do Trabalho 1 - Modelagem</center>
+
+## **DER - Diagrama Entidade Relacionamento**
+
+O Diagrama Entidade-Relacionamento é uma representação gráfica do MER, que utiliza símbolos para demonstrar as entidades, seus atributos e os vínculos entre elas. Ele facilita o entendimento da estrutura de dados, promovendo a comunicação eficiente entre equipes técnicas e partes interessadas.
+
+Segue o link para o MER:
+
+[Versão 1 do DER](https://viewer.diagrams.net/#G1jwFfDf54Y0syDP8PyWOZ2OZu6pEPBTmq#%7B%22pageId%22%3A%22R2lEEEUBdFMjLlhIrx00%22%7D)
diff --git a/docs/entrega-1/MER.md b/docs/entrega-1/MER.md
@@ -0,0 +1,154 @@
+# <center>Entrega do Trabalho 1 - Modelagem</center>
+
+##  **MER - Modelo Entidade Relacionamento**
+
+O Modelo Entidade-Relacionamento é uma abordagem conceitual que organiza as informações de um sistema, definindo entidades, seus atributos e os relacionamentos entre elas. Ele é essencial para compreender e estruturar os dados de forma lógica, servindo como base para o planejamento do banco de dados e a identificação das necessidades do projeto.
+
+## **Entidades**
+
+- Personagem
+    - PC
+    - NPC
+        - Comerciante
+        - Inimigo
+- Missão
+- Diálogo
+- Item
+    - Coletável
+    - Equipamento
+        - Armadura
+        - Arma
+        - Implante cibernético
+- Facção
+- Classe
+- Distrito
+- Célula do mundo
+- Origem
+- Instância Inimigo
+- Habilidade
+- Background
+- Loja
+
+## **Atributos**
+
+- Personagem: [<ins>_id_personagem</ins>,tipo_]
+    - PC: [<ins>_id_personagem</ins>,id_celula,id_faccao,id_classe,id_origem,id_background,habilidade_cibernetica,habilidades,forca,destreza,constituicao,
+    inteligencia,tecnologia,carisma,hp,hp_atual,nivel,nome,descricao_]
+    - NPC: [_<ins>_id_personagem</ins>,tipo_]
+        - Comerciante: [_<ins>id_comerciante</ins>,id_personagem,id_celula,nome,descricao_]
+        - Inimigo: [_<ins>id_inimigo</ins>,id_personagem,id_celula,forca,destreza,constituicao,inteligencia,tecnologia,carisma,nome,descricao_]  
+- Missão: [_<ins>id_missao</ins>,nome,descrição,dificuldade,objetivo_]
+- Diálogo: [_<ins>id_interacao</ins>,mensagem_atual,responsavel_mensagem_]
+- Item: [_<ins>id_item</ins>,tipo_]
+    - Coletável: [_<ins>id_item</ins>,id_celula,nome,descricao,valor,raridade_]
+    - Equipamento: [_<ins>id_item</ins>,tipo_]
+        - Armadura: [_<ins>id_item</ins>,id_celula,nome,descricao,valor,defesa,velocidade_ataque,raridade_]
+        - Arma: [_<ins>id_item</ins>,id_celula,nome,descricao,valor,raridade,municao,dano,alcance]
+        - Implante cibernético: [_<ins>id_item</ins>,id_celula,nome,descricao,valor,raidade,custo_energia,dano,alcance_]
+- Facção: [_<ins>id_faccao</ins>,nome,descricao,ideologia,nivel_influencia,recursos_]
+- Classe: [_<ins>id_classe</ins>,nome,descricao,pontos_vida_bonus_]
+- Distrito: [_<ins>id_distrito</ins>,nome,descricao,distritos,range_maximo,quantidade_personagens_]  
+- Célula do mundo: [_<ins>id_celula</ins>,id_disrito,nome,descricao,destino_]
+- Origem: [_<ins>id_origem</ins>,nome,descricao,cultura,bonus_]
+- Instância Inimigo: [_<ins>id_instancia_inimigo</ins>,id_inimigo,id_celula,hp,hp_atual_]
+- Habilidade: [_<ins>id_habilidade</ins>,nome,tipo_habilidade,descricao,descricao,custo_de_uso,dano,velocidade_movimento_]
+- Background: [_<ins>id_backgroud</ins>,salario,habilidades,funcao_]
+- Loja: [_<ins>id_loja</ins>,id_comerciante,id_instancia_item_]
+
+
+## **Relacionamentos**
+
+
+- Personagem e Inventário
+    - (1,1) Cada Personagem possui um único Inventário.
+    - (1,1) Um Inventário pertence a um único Personagem.
+
+- Personagem e Facção
+    - (1,1) Cada Personagem pertence a uma única Facção.
+    - (0,N) Uma Facção pode ter vários Personagens associados.
+
+- Personagem e Origem
+    - (1,1) Cada Personagem possui uma única Origem.
+    - (0,N) Uma Origem pode estar associada a vários Personagens.
+
+- Personagem e Classe
+
+    - (1,1) Cada Personagem possui uma única Classe.
+    - (0,N) Uma Classe pode ser associada a várias Personagens.
+
+- Personagem e Background
+    - (1,1) Cada Personagem possui um único Background.
+    - (0,N) Um Background pode estar associado a várias Personagens.
+
+- Personagem e Habilidade
+    - (0,N) Uma personagem pode possuir várias habilidades.
+    - (0,N) Uma habilidade pode pertencer a vários Personagens.
+
+- Instância de Item e Item
+    - (1,N) Um Item pode ter várias Instâncias de Item.
+    - (1,1) Cada Instância de Item representa um único Item.
+
+- Instância de Item e Inventário
+    - (0,N) Um Inventário contém várias Instâncias de Item.
+    - (1,1) Cada Instância de Item pertence a um único Inventário.
+    - (0,N) Uma Instância de Item representa um Item.
+    - (1,1) Um item pode ter várias instâncias.
+
+- Célula e Distrito
+    - (1,1) Uma célula pertence a um único distrito.
+    - (0,N) Um distrito contém várias Células.
+
+- Instância Inimigo e Célula
+    - (1,1) Uma Instância Inimigo pode está em uma célula
+    - (1,N) Uma Célula pode ter várias Instância Inimigo
+
+- Negociação
+    - (1,1) Uma negociação envolve um Mercador.
+    - (0,N) Um Mercador pode realizar várias negociações
+    - (1,1) Uma negociação envolve um PC.
+    - (0,N) Um PC pode realizar várias negociações.
+
+- PC e NPC
+    - (N,N) Um PC interage com várias NPC
+    - (N,N) Um NPC interage com vários PC
+
+- NPC e Interação
+    - (1,N) Um NPC pode ter várias Interações.
+    - (1,1) Cada Interação envolve um único NPC.
+
+- PC e Interação
+    - (1,N) Um PC pode ter várias Interações.
+    - (1,1) Cada Interação envolve um único PC.
+
+- PC e Instância Inimigo
+    - (1,N) Um PC consegue combater vários Instância Inimigo
+    - (1,N) Um Inimigo Instância consegue ser combatido por vários PC
+
+- Interação e Diálogo
+    - (1,1) Uma Interação gera um único Diálogo.
+    - (1,1) Cada Diálogo é gerado por uma única Interação.
+
+- Combate e Instância Inimigo
+    - (1,N) Um Combate pode envolver várias Instâncias de Inimigo.
+    - (1,1) Cada Instância de Inimigo participa de um único Combate.
+
+- Personagem e Distrito
+    - (1,1) Cada Personagem está em um único Distrito.
+    - (0,N) Um Distrito pode conter vários Personagens.
+
+- Célula e Instancia de Item
+    - (0,N) Uma Célula pode conter várias Instâncias de Itens.
+    - (1,1) Cada Instância de Item está em uma única Célula.
+
+- Personagem e Missão
+    - (1,N) Um Personagem pode realizar várias Missões.
+    - (1,1) Cada Missão é realizada por um único Personagem.
+
+- Comerciante e Loja
+    - (1,1) Cada Comerciante possui uma única Loja.
+    - (1,1) Cada Loja é gerenciada por um único Comerciante.
+
+- Facção e Distrito
+    - (1,1) Uma Facção domina um único Distrito
+    - (1,1) Um único Distrito é dominado por uma única Facção
+
diff --git a/docs/entrega-1/ModeloRelacional.md b/docs/entrega-1/ModeloRelacional.md
@@ -0,0 +1,9 @@
+# <center>Entrega do Trabalho 1 - Modelagem</center>
+
+## **Modelo Relacional**
+
+O Modelo Relacional organiza os dados em tabelas e traduz as abstrações do MER e do DER para uma estrutura prática de banco de dados. Ele assegura integridade, normalização e eficiência no gerenciamento das informações, sendo amplamente utilizado devido à sua robustez e simplicidade na manipulação de dados.     
+
+Segue link para o Modelo Relacional:
+
+[Versão 1 do Modelo Relacional](https://viewer.diagrams.net/?src=about#G1KWbNH4I2N6N-O3vyquGGOQwLZAh82VL2#%7B%22pageId%22%3A%22C5RBs43oDa-KdzZeNtuy%22%7D)
diff --git a/docs/img/arma_dd.png b/docs/img/arma_dd.png
diff --git a/docs/img/armadura_dd.png b/docs/img/armadura_dd.png
diff --git a/docs/img/background_dd.png b/docs/img/background_dd.png
diff --git a/docs/img/carbon2185.jpeg b/docs/img/carbon2185.jpeg
diff --git a/docs/img/carbonlogowhite.png b/docs/img/carbonlogowhite.png
diff --git a/docs/img/celula_dd.png b/docs/img/celula_dd.png
diff --git a/docs/img/classes_dd.png b/docs/img/classes_dd.png
diff --git a/docs/img/coletavel_dd.png b/docs/img/coletavel_dd.png
diff --git a/docs/img/comerciante_dd.png b/docs/img/comerciante_dd.png
diff --git a/docs/img/dialogo_dd.png b/docs/img/dialogo_dd.png
diff --git a/docs/img/distrito_dd.png b/docs/img/distrito_dd.png
diff --git a/docs/img/equipamento_dd.png b/docs/img/equipamento_dd.png
diff --git a/docs/img/faccao_dd.png b/docs/img/faccao_dd.png
diff --git a/docs/img/favicon-16x16.png b/docs/img/favicon-16x16.png
diff --git a/docs/img/favicon-32x32.png b/docs/img/favicon-32x32.png
diff --git a/docs/img/habilidade_dd.png b/docs/img/habilidade_dd.png
diff --git a/docs/img/implantecibernetico_dd.png b/docs/img/implantecibernetico_dd.png
diff --git a/docs/img/inimigo_dd.png b/docs/img/inimigo_dd.png
diff --git a/docs/img/instanciainimigo_dd.png b/docs/img/instanciainimigo_dd.png
diff --git a/docs/img/instanciaitem_dd.png b/docs/img/instanciaitem_dd.png
diff --git a/docs/img/inventario_dd.png b/docs/img/inventario_dd.png
diff --git a/docs/img/item_dd.png b/docs/img/item_dd.png
diff --git a/docs/img/loja_dd.png b/docs/img/loja_dd.png
diff --git a/docs/img/missao_dd.png b/docs/img/missao_dd.png
diff --git a/docs/img/npc_dd.png b/docs/img/npc_dd.png
diff --git a/docs/img/origem_dd.png b/docs/img/origem_dd.png
diff --git a/docs/img/pc_dd.png b/docs/img/pc_dd.png
diff --git a/docs/img/personagem_dd.png b/docs/img/personagem_dd.png