Merge branch 'main' into dev

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# To do
+
+These are some ideas that come in my mind but it is surely not exhaustive. Feel free to give suggestions on Issues or on the discord server.
+
+- Improve dialogs to introduce the Submod the first time (telling what it does, how is it different from actual Monika) :white_check_mark:
+- Add saving history of conversations to see again your best interactions
+- Making it like a messaging app with questions/answers listed on a same window
+- Define better facial expressions corresponding to predifined emotions (happiness,fear,surprise...)
+- Convert more functionalities to executable files (TTS,Speech Recognition) :white_check_mark:
+- Make the better TTS available only on MacOS/Linux for now usable also on other OS.
+- Link this with Live2D for face movements with speech and emotions
+- Face recognition for Monika only to recognize you
+- Training new models for MEL Spectrogram Generation (Mixed TTS...) and Vocoders (UnivNet...)
+- Speech to text to convert your own voice in text and directly speak with Monika :white_check_mark:
+- Better face emotions detection :white_check_mark:
+- Add possibility to see when microphone starts recording in the game for STT :white_check_mark:
+
+
+# How can you contribute:
+
+## Simple scripting
+
+Renpy files are accessible on the repository [here](https://github.com/Rubiksman78/MonikA.I/blob/main/game/Submods/AI_submod).
+You can check out `monikai_topics.rpy` with a set of scripted dialogues to introduce the mod, announce some bugs...etc. Feel free to propose better ones, tune the facial expressions or other topics you find pertinents in this submod
+
+## More coding in renpy
+
+There are other renpy files available:
+- `monikai_buttons.rpy` for the buttons on the main screen to use text chat or voice chat
+- `monikai_chat.rpy` for the main functions about chatting with the bot
+- `monikai_voicing.rpy` to overwrite the `renpy.say` for the full voicing mode
+- `monikai_emotion.rpy` to do the facial emotion detection (available soon)
+
+## Python code
+
+You can take a look at the source code if you want to uprade things concerning the tkinter login interface `login_screen.py` or the main scripts like `main.py` (chat) or `voicing.py` (full voicing).
+
+There are other scripts that can be useful in the repository, some of them are in the folder `old_scripts` because they are no longer indate with the releases.

README.md

@@ -22,33 +22,13 @@ Check the discord [server](https://discord.gg/2RsPuaDxEn) if you have some quest
 
 # User friendly mode
 
-## :boom: Installation (build for Windows OS only now)
-
-- Go to the Github project: https://github.com/Rubiksman78/MonikA.I
-- Go to Releases
-![release](https://cdn.discordapp.com/attachments/1063968734831706217/1063968923382464692/tuto1.png)
-- Download MonikA.I-version.zip and game.zip
-![release2](https://cdn.discordapp.com/attachments/1063968734831706217/1063969007230795776/tuto2.png)
-- Unzip game.zip and put it in your DDLC folder, at the same level as the existing game (they have to merge together)
-![release3](https://cdn.discordapp.com/attachments/1063968734831706217/1063969077086916618/tuto3.png)
-- Unzip MonikA.I-version.zip wherever you want
-- Go to MonikA.I-version -> dist -> main -> main.exe and double click the executable
-![release4](https://cdn.discordapp.com/attachments/1063968734831706217/1063969321757458592/tuto5.png)
-- One launched, enter your email (not username) and password from your character.ai account
-- Write the path of your DDLC folder 
-- Choose character (0 or 1 now) and other options
-- Be sure to click every button with the option you want
-- Submit and play ! 
-
-![GUI](https://cdn.discordapp.com/attachments/1063968734831706217/1063969409133187102/tuto4.png)
-
-For the full voicing mode:
-- Do the same steps 
-- Instead of launching `main.exe`, launch `voice.exe`
-
-![voicing](images/voicing.png)
-
-Your antivirus might block the execution of the file but it is a common issue with `pyinstaller` to convert python files to executables. All the code is available here for transparency.
+## :boom: Installation 
+
+(Build is for Windows OS only, see `Python version` section for other OS)
+
+This version includes conversing with chatbots or full voicing of the game, the two modes might not be compatible so it is preferale to use them separetely.
+
+To install the user version with executables, I've made a tutorial [HERE](../../wiki/User-friendly-tutorial)
 
 ## :fire: Features
 
@@ -58,20 +38,27 @@ Your antivirus might block the execution of the file but it is a common issue wi
 
 ![Character AI](images/image_1.png)
 
-## :alarm_clock: To develop (if you want to contribute)
-- Improve dialogs to introduce the Submod the first time (telling what it does, how is it different from actual Monika) :white_check_mark:
-- Add saving history of conversations to see again your best interactions
-- Making it like a messaging app with questions/answers listed on a same window
-- Define better facial expressions corresponding to predifined emotions (happiness,fear,surprise...)
-- Convert more functionalities to executable files (TTS,Speech Recognition) :white_check_mark:
-- Make the better TTS available only on MacOS/Linux for now usable also on other OS.
-- Link this with Live2D for face movements with speech and emotions
-- Face recognition for Monika only to recognize you
-- Training new models for MEL Spectrogram Generation (Mixed TTS...) and Vocoders (UnivNet...)
-- Speech to text to convert your own voice in text and directly speak with Monika :white_check_mark:
-- Better face emotions detection :white_check_mark:
-- Add possibility to see when microphone starts recording in the game for STT :white_check_mark:
-- *Feel free to suggest improvements or new AI features you would like to see*
+# How to contribute
+
+If you want to contribute to the project, you can check out this [page](../../wiki/How-to-contribute).
+It is not necessary to know how to code and you can add dialogs, expressions. Don't hesitate to propose new things if you have more experience !
+
+# Demonstrations
+
+## :video_game: In Game
+
+The features are available in a specific `AI` Talk menu in the game.
+![Talk menu](images/event_mas.png)
+
+- Click on `Let's chat together` to use the Character AI Chatbot
+- Click on `Tell me about Pytorch` if you think it is superior to Tensorflow
+
+There is also the possibility of using buttons on the main screen to directly chat. These can be disabled in the Settings Submods if you don't like them.
+![Talk buttons](images/buttons_mas.png)
+
+## :cinema: Video Demonstration
+
+https://user-images.githubusercontent.com/66365083/209359921-a4fdad5e-abbd-4550-a1fb-62d695e76c51.mp4
 
 # Python version
 
@@ -104,19 +91,6 @@ For voicing of the game in real time, launch `voicing.py` and launch DDLC yourse
 
 You can change the voice used by replacing the extract `talk_13.wav` in the `audio` folder by another audio extract. The longer the extract, the longer the TTS will take to generate the audio at each turn.
 
-## :video_game: In Game
-
-The features are available in a specific `AI` Talk menu in the game.
-![Talk menu](images/image_2.png)
-
-- Click on `Let's chat together` to use the Character AI Chatbot
-- Click on `Look for me` to use the facial emotions detection in an interactive session
-- Click on `Tell me about Pytorch` if you think it is superior to Tensorflow
-
-## :cinema: Video Demonstration
-
-https://user-images.githubusercontent.com/66365083/209359921-a4fdad5e-abbd-4550-a1fb-62d695e76c51.mp4
-
 ## :microphone: Better Voice (only on Linux,MacOS or WSL)
 
 The voice used by Your TTS is obtained with zero-shot learning so it is not perfect and very closed to the original voice. To improve it, you can use the [FastPitch TTS from Nvidia NeMo](https://github.com/NVIDIA/NeMo).

game/Submods/AI_submod/monikai_header.rpy

@@ -16,4 +16,4 @@ init -989 python:
             repository_name="MonikA.I",
             extraction_depth=3,
             attachment_id = 1
-        )
+        )