Consolida núcleo (presença, peer actions, MessageDispatcher), chat e screencast na galeria, documentação PT-BR e testes JUnit; remove mpChat do catálogo em favor do chat unificado. Co-authored-by: Cursor <cursoragent@cursor.com>
1.9 KiB
1.9 KiB
Guia para desenvolvedor e agente
Esta documentação descreve apenas a ferramenta Pitiupi neste repositório: build, rede, plugins e convenções de código. Quem clona o projeto não precisa de pastas ou ferramentas de meta-desenvolvimento externas; mantenha referências técnicas e tutoriais limitados ao que está em docs/ e no código do próprio repo.
Leitura mínima antes de mudar código
- 00_quickstart.md — build e execução
- 04_inicializacao_e_gui.md — boot e diagrama
- 09_sistema_de_plugins.md — contrato de extensão
- 14_arquitetura_e_manutencao.md — mapa de pacotes
Por tipo de tarefa
| Tarefa | Ler primeiro |
|---|---|
| Novo plugin (aluno) | 10_tutorial_plugin.md, 11_plugins_referencia.md |
| Bug UDP / multicast | 05_udp_multicast.md, appendix_portas_e_multicast.md |
| Bug TCP / conexão | 06_tcp_conexoes.md |
| Presença / lista de usuários | 08_heartbeat_e_presenca.md |
| Desserialização / mensagens | 07_mensagens_e_serializacao.md |
Gate de build
Compilar núcleo e os dois plugins do catálogo:
cd pitiupi && ant jar && ant test
cd plugins/chat && ant jar
cd plugins/screencast && ant jar
Ou na raiz do clone: ./scripts/pitiupi.sh build --all.
Requer JDK e Ant no PATH. Teste manual em rede: 15_testes_e_gate.md.
Convenções
- Código e identificadores em inglês (pacotes
pitiupi.*). - Documentação em português (BR) em
docs/. - Evitar alterar o núcleo para necessidades de um único plugin — preferir extensão via
Plugin.