Skip to content

Commit 6901d31

Browse files
authored
Release 1.0.0 (#27)
* [ADD] Discord System * [REMOVE] Socket System * [FIX] Webhook Spam * [CHANGE] Update Webhook System * [ADD] Github Templates * Update Readme * [CHANGE] Update settings loader * Update Changelog * [ADD] Avatar Picture * Fix Pre-Commit Issue * Update Changelog
1 parent 6dcbc68 commit 6901d31

24 files changed

Lines changed: 405 additions & 1060 deletions
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
title: "[BUG]: "
4+
labels: ["bug"]
5+
projects: ["eve-alert"]
6+
assignees:
7+
- octocat
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to fill out this bug report!
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: What happened?
17+
description: Also tell us, what did you expect to happen?
18+
placeholder: Tell us what you see!
19+
value: "A bug happened!"
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: logs
24+
attributes:
25+
label: Relevant log output
26+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
27+
render: shell
28+
- type: checkboxes
29+
id: terms
30+
attributes:
31+
label: Code of Conduct
32+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/geuthur/EVE-Alert-Opensource/blob/main/CODE_OF_CONDUCT.md).
33+
options:
34+
- label: I agree to follow this project's Code of Conduct
35+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Suggestion Request
2+
description: What the program should have.
3+
title: "[SUGGESTION]: "
4+
labels: ["suggestion"]
5+
projects: ["eve-alert"]
6+
assignees:
7+
- geuthur
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to fill out this suggestion request!
13+
- type: textarea
14+
id: suggestion
15+
attributes:
16+
label: Draw your suggestion
17+
description: Draw your suggestion, or write code, or anything that can help us understand your suggestion.
18+
placeholder: Draw your suggestion here!
19+
validations:
20+
required: true
21+
- type: checkboxes
22+
id: terms
23+
attributes:
24+
label: Code of Conduct
25+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/geuthur/EVE-Alert-Opensource/blob/main/CODE_OF_CONDUCT.md).
26+
options:
27+
- label: I agree to follow this project's Code of Conduct
28+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Please include a summary of the changes and the related issue number (if applicable).
2+
3+
## Description
4+
5+
### Type of Changes
6+
Please select the type of changes made in this pull request:
7+
- [ ] Bug Fix
8+
- [ ] New Feature
9+
- [ ] Documentation Update
10+
- [ ] Other (please specify):
11+
12+
### Checklist
13+
Please ensure the following before submitting your pull request:
14+
- [ ] I have read the [contributing guidelines](https://github.com/geuthur/EVE-Alert-Opensource/blob/main/CONTRIBUTING.md).
15+
- [ ] My code follows the code style of this project.
16+
- [ ] I have performed a self-review of my code.
17+
- [ ] I have commented my code where necessary.
18+
- [ ] All new and existing tests passed.

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
## [1.0.0] 2025-03-30
2+
3+
### Changed
4+
5+
- Removed Socket System
6+
- The Socket System has been removed and we now use Discord Webhook to share Intel.
7+
- Setting Loader
8+
- Missing Keys will be created.
9+
- Update Dependencies
10+
- Open-CV Updated to 4.11.\*
11+
- ScreenInfo to 0.8.1
12+
- MSS to 10.0.0
13+
14+
### Added
15+
16+
- Discord System
17+
- All alarms are sent to a Discord webhook with the system name.
18+
- dhooks-lite
19+
- Discord Webhook library
20+
121
## [0.9.0] - 2025-01-08
222

323
### Changed

CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[faq]: https://www.contributor-covenant.org/faq
129+
[homepage]: https://www.contributor-covenant.org
130+
[mozilla coc]: https://github.com/mozilla/diversity
131+
[translations]: https://www.contributor-covenant.org/translations
132+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing to This Project
2+
3+
Thank you for considering contributing to our project! Here are some guidelines to help you get started.
4+
5+
## Getting Started
6+
7+
1. **Fork the repository**: Click the "Fork" button at the top right of the repository page.
8+
9+
1. **Clone your fork**: Clone your forked repository to your local machine.
10+
11+
```sh
12+
git clone https://github.com/geuthur/EVE-Alert-Opensource.git
13+
```
14+
15+
1. **Set up the upstream remote**: Add the original repository as a remote to keep your fork up to date.
16+
17+
```sh
18+
git remote add upstream https://github.com/geuthur/EVE-Alert-Opensource.git
19+
```
20+
21+
## Pre-commit Hooks
22+
23+
We use pre-commit hooks to ensure code quality and consistency. Please make sure you have pre-commit installed and set up.
24+
25+
1. **Install pre-commit**: If you don't have pre-commit installed, you can install it using pip.
26+
27+
```sh
28+
pip install pre-commit
29+
```
30+
31+
1. **Install the hooks**: Run the following command to install the pre-commit hooks.
32+
33+
```sh
34+
pre-commit install
35+
```
36+
37+
1. **Use Pre Commit**
38+
39+
Check all files
40+
41+
```sh
42+
pre-commit run --all-files
43+
```
44+
45+
If you want only one of the hooks like `eslint`
46+
47+
```sh
48+
pre-commit run eslint
49+
```
50+
51+
## Branching und Contributing via Pull Requests
52+
53+
Before creating a pull request, make sure that you have forked the repository and are working on your fork. This ensures that your changes are isolated and do not affect the original repository until they are reviewed and merged.
54+
55+
The `master` branch should always be kept up to date to avoid conflicts. This means that all changes integrated into the `master` branch should be thoroughly reviewed and tested before being merged. Regular updates and synchronizations with the `master` branch help to identify and resolve potential conflicts early.
56+
57+
Before creating a new feature, an issue should always be opened first. This serves to start a discussion about the planned feature and ensure that all team members are informed about the planned changes. Through discussion, potential problems and improvements can be identified and considered early. This promotes a collaborative working approach and contributes to the quality and consistency of the project.

README.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ EVE Alert - Check every 1-3 seconds if the Local has an Enemy or Neutral in Syst
1212
- [Features](#features)
1313
- [Download](#step1)
1414
- [Detection](#detection)
15-
- [Socket System](#socket)
16-
- [Server - Main Program](#server)
17-
- [Client - Listener](#client)
15+
- [Discord Webhook](#webhook)
1816
- [Showcase](#showcase)
1917
- [Donation](#donation)
2018
- [Terms](#terms)
@@ -27,11 +25,7 @@ EVE Alert - Check every 1-3 seconds if the Local has an Enemy or Neutral in Syst
2725
- Start/Stop System
2826
- Monitoring Region in real-time (also possible to stream via Discord for friends)
2927
- Faction Spawn Detection - Now you can set a Faction Spawn Detection and it will play a sound if a faction is in Site (can also used for other thing like active modules or something)
30-
- The Socket System allows you to have one server and multiple clients that can connect to it to receive alarms.
31-
32-
## Upcoming Features
33-
34-
- Discord Webhook support
28+
- Webhook System allows to share alarms into Discord Webhook to create a Intel System anonymous.
3529

3630
### Download Version<a name="step1"></a>
3731

@@ -45,30 +39,15 @@ Go to [the releases page](https://github.com/Geuthur/EVE-Alert-Opensource/releas
4539
If you want more, simply add more images to the "img/" folder with naming image_1, image_2, image_3, etc.\
4640
Note: If you have different UI Scaling you need to add these images to the img folder like the `image_1_90%`
4741

48-
## Server Usage<a name="server"></a>
49-
50-
> [!NOTE]
51-
> **This Version is for Single User!**
52-
53-
The server is responsible for sending messages to the connected clients. It can send two types of messages: Normal and Alarm. When an Alarm message is sent, all connected clients will receive it and can take appropriate actions, such as playing a sound.
54-
55-
- Simply launch Server.exe, and a menu will appear. You can configure all your settings there. Afterward, click on "Start."
56-
- If the Alert doesn't respond to the local chat, you can reduce the detection accuracy or double-check if you've set the region correctly.
57-
- If both settings are 100% accurate and your interface is not blurred, make a new screenshot from your neutral symbol and try it with your own image
58-
- You can edit all images & sounds by yourself only the name must be the same
59-
60-
Optional:
61-
62-
- Activate Socket Server for Broadcast Mode
63-
- Mute Alarm for Just Broadcast
42+
## Discord Webhook Usage (optinal)<a name="webhook"></a>
6443

65-
## Client Usage<a name="client"></a>
44+
The webhook is responsible for sending messages to a Discord Server.
6645

67-
> [!NOTE]
68-
> To Use the Client Version you need at least 1 Active Server!
46+
- Open The Setting Menu and put a Discord Webhook URL in the Webhook Field
47+
- Setup a System Name: `Jita 4-4`
48+
- You can also mute the Alarm sound by checking the Mute Alarm Checkbox
6949

70-
- The client program can be used to connect to a socket server and continuously receives messages. The messages can be in one of two states: Normal or Alarm.
71-
- When the client receives an Alarm message, it plays a sound.
50+
If there is a problem with the webhook, the webhook system is automatically deactivated.
7251

7352
## Showcase<a name="showcase"></a>
7453

evealert/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
"""Initialize the app"""
22

3-
__version__ = "0.9.0"
3+
__version__ = "1.0.0"
44
__title__ = "EVE Alert"

evealert/client/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)