• 🎯 About The Project
• ✨ Features
• 📦 Requirements
• 📥 Installation
  • Windows Installation
  • Linux Installation
  • macOS Installation
  • Building From Source
• 🚀 User Guide
• 📸 Screenshots
• ⚙️ Configuration
• ❓ Frequently Asked Questions
• 🐛 Troubleshooting
• 📄 License

XCR School Bell is a professional bell management system designed for schools. With its modern and user-friendly interface, you can easily manage different bell types such as student bell, teacher bell, and break bell.

• 🎨 Modern Interface: Elegant design with dark theme that's easy on the eyes
• ⏰ Automatic Bells: Automatic bell ringing at scheduled times
• 🎵 Multi-Format Support: MP3, WAV, OGG, FLAC, M4A, AAC and more
• 🎤 Live Announcements: Make instant announcements via microphone
• 💾 Backup System: Safely store your settings
• 🎹 Soundpad: Quick access panel for custom sounds

• ▶️ One-click sound playback
• ⏸️ Pause and resume functionality
• 🎚️ Set sound range (start/end points)
• 🎨 Color-coded sounds
• ♾️ Unlimited sound additions

• 🔴 Press and hold to announce
• 🎚️ Microphone volume adjustment
• 📢 Instant speaker output

• 📅 Dated automatic backups
• 📤 Export functionality
• 📥 Import functionality
• 🔄 Easy restoration

1. Install Java JDK 11+

   If Java is not installed, download from Adoptium:

   https://adoptium.net/temurin/releases/
   

   Or using winget:

   winget install EclipseAdoptium.Temurin.11.JDK

2. Download the Application

   Download XCR_School_Bell.jar from the Releases page.

3. Run the Application

   Double-click the JAR file or run from command line:

   java -jar XCR_School_Bell.jar

4. (Optional) Install FFmpeg

   For advanced audio format support:

   # Using Chocolatey
   choco install ffmpeg
   
   # Or using Winget
   winget install FFmpeg.FFmpeg

1. Right-click on Desktop → New → Shortcut
2. Enter the location:

   javaw -jar "C:\Program Files\SchoolBell\XCR_School_Bell.jar"
   

3. Name it: School Bell
4. Choose your preferred icon

1. Press Win + R
2. Type shell:startup and press Enter
3. Copy the JAR file shortcut to the opened folder

1. Install Java JDK 11+

   # Update package list
   sudo apt update
   
   # Install OpenJDK 11
   sudo apt install openjdk-11-jdk -y
   
   # Verify Java version
   java -version

2. Install FFmpeg (Optional but Recommended)

   sudo apt install ffmpeg -y

3. Download the Application

   # Create download directory
   mkdir -p ~/SchoolBell
   cd ~/SchoolBell
   
   # Download JAR file
   wget https://github.com/X-croot/SchoolBell/releases/download/1.0.0/XCR_School_Bell.jar

4. Run the Application

   java -jar XCR_School_Bell.jar

5. (Optional) Create Desktop Shortcut

   cat > ~/.local/share/applications/schoolbell.desktop << EOF
   [Desktop Entry]
   Name=School Bell
   Comment=School Bell Management System
   Exec=java -jar $HOME/SchoolBell/XCR_School_Bell.jar
   Icon=audio-volume-high
   Terminal=false
   Type=Application
   Categories=Education;Audio;
   EOF

# Install Java
sudo dnf install java-11-openjdk -y

# Install FFmpeg
sudo dnf install ffmpeg -y

# Run the application
java -jar XCR_School_Bell.jar

# Install Java
sudo pacman -S jdk11-openjdk

# Install FFmpeg
sudo pacman -S ffmpeg

# Run the application
java -jar XCR_School_Bell.jar

# Create service file
sudo tee /etc/systemd/system/schoolbell.service << EOF
[Unit]
Description=School Bell Application
After=network.target sound.target

[Service]
Type=simple
User=$USER
Environment=DISPLAY=:0
ExecStart=/usr/bin/java -jar /home/$USER/SchoolBell/XCR_School_Bell.jar
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target
EOF

# Enable and start the service
sudo systemctl daemon-reload
sudo systemctl enable schoolbell
sudo systemctl start schoolbell

# Check service status
sudo systemctl status schoolbell

1. Install Java JDK 11+

   # Using Homebrew
   brew install openjdk@11
   
   # Add to PATH
   echo 'export PATH="/usr/local/opt/openjdk@11/bin:$PATH"' >> ~/.zshrc
   source ~/.zshrc

2. Install FFmpeg

   brew install ffmpeg

3. Run the Application

   java -jar XCR_School_Bell.jar

If you want to build the project yourself:

1. Install Requirements

   • JDK 11+
   • Maven 3.6+
   • Git

2. Clone the Repository

   git clone https://github.com/X-croot/SchoolBell.git
   cd SchoolBell

3. Build with Maven

   # Download dependencies and compile
   mvn clean package
   
   # Create executable JAR
   mvn package shade:shade

4. Run the Built JAR

   java -jar target/XCR_School_Bell.jar

1. Launch the application
2. Make sure "BELL SYSTEM ACTIVE" is enabled at the top
3. Click on the "📅 Schedule" tab from the menu

1. Open the Schedule tab
2. Select the desired day (Monday, Tuesday, etc.)
3. Click the "➕ Add Lesson" button
4. For each lesson, enter:
   - Student Bell Time (e.g., 08:30)
   - Teacher Bell Time (e.g., 08:25)
   - Break Bell Time (e.g., 09:10)
5. Add as many lessons as needed
6. Click the "💾 SAVE" button

1. Open the "🔊 Bell Sounds" tab
2. Find the relevant bell type (Student/Teacher/Break)
3. Click the "📂 Browse" button
4. Select your sound file (MP3, WAV, OGG, etc.)
5. Test with the "▶️ Test" button
6. Adjust the volume level

1. Open the "🎹 Soundpad" tab
2. Click the "➕ ADD NEW SOUND" button
3. Select a sound file
4. Give it a name
5. Click on the added sound card to play
6. Click again to stop

1. Open the "🎤 Live Announcement" tab
2. Press and hold the microphone icon
3. Speak your announcement
4. Release to stop

Creating a Backup:
1. Open the "💾 Backup" tab
2. Click the "💾 Create Backup" button

Restoring from Backup:
1. Select a backup from the list
2. Click the "🔄 Restore" button
3. Confirm the action

📌 Note: Visit the Wiki page for screenshots or download the application to experience it yourself!

• 🌙 Dark theme (eye-friendly)
• 🎨 Colorful accent colors
• 📱 Responsive design
• 🖱️ Intuitive usage

Application data is stored in the following folders:

data/
├── config.json          # Main configuration file
├── sounds/              # Bell and soundpad audio files
│   ├── student.wav
│   ├── teacher.wav
│   ├── break.wav
│   └── snd_*.wav        # Soundpad sounds
└── backups/             # Backup files
    └── backup_*.json

{
  "bellActive": true,
  "micVol": 100,
  "schedule": [
    {
      "day": "Monday",
      "lessons": [
        {
          "student": "08:30",
          "teacher": "08:25",
          "break": "09:10"
        }
      ]
    }
  ],
  "sounds": {
    "student": {"file": "student", "volume": 100},
    "teacher": {"file": "teacher", "volume": 100},
    "break": {"file": "break", "volume": 100}
  },
  "soundpad": []
}

java -version

# Windows
set PATH=%PATH%;C:\Program Files\Java\jdk-11\bin

# Linux/macOS
export PATH=$PATH:/usr/lib/jvm/java-11-openjdk/bin

1. Check default audio output device
2. Restart PulseAudio service (Linux):

   pulseaudio -k && pulseaudio --start

• Stop sounds playing in the background
• Remove unnecessary sounds from Soundpad

1. Close the application
2. Delete data/config.json
3. Restart the application (clean installation)

# Add user to audio group
sudo usermod -a -G audio $USER

# Log out and log back in, or:
newgrp audio

This project is licensed under the MIT License. See the LICENSE file for details.

MIT License

Copyright (c) 2026 Can Ünüvar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.