Skip to content

Commit 7014ec8

Browse files
more professional readme
1 parent 995647b commit 7014ec8

1 file changed

Lines changed: 9 additions & 88 deletions

File tree

README.md

Lines changed: 9 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,18 @@
33
</p>
44

55
# OVERSEE Worldwide Viewer
6-
76
A comprehensive GUI application for monitoring and managing IP cameras worldwide. The application provides multiple views including a map view, matrix view, and list view for efficient camera management.
87

98
## Features
109
- **Map View**: Visualize camera locations on an interactive map
1110
- Multiple map styles (OpenStreetMap, Google normal, Google satellite) using tkintermapview
12-
- Clickable markers with camera information (in development)
11+
- Clickable markers with camera information
1312
- Real-time camera status updates
14-
- Automatic geolocation of IP addresses (using ipinfo)
13+
- Automatic geolocation of IP addresses (using ipinfo scrape)
1514

1615
- **Matrix View**: Grid display of multiple camera feeds
1716
- Real-time video streams
18-
- Customizable grid layout (not much but sure)
17+
- Customizable grid layout (limited)
1918
- Camera status indicators
2019

2120
- **List View**: Detailed camera management
@@ -25,81 +24,10 @@ A comprehensive GUI application for monitoring and managing IP cameras worldwide
2524
- Camera status monitoring
2625

2726
## Installation
28-
Binaries coming soon. They will be located somewhere on silverflag.net. I'll update this with the link when it is ready.
29-
30-
## Function
31-
1. The application will:
32-
- Initialize the IP coordinates database
33-
- Load camera information
34-
- Start the main GUI
35-
36-
2. Using the interface:
37-
- **Map View**: View and interact with camera locations
38-
- **Matrix View**: Monitor multiple camera feeds
39-
- **List View**: Manage individual cameras
40-
41-
## Configuration
42-
43-
### Settings File
44-
The `settings.py` file contains important configuration options:
45-
- IP list file location
46-
- Database paths
47-
- Map tile server settings
48-
- Camera stream parameters
49-
50-
### IP List Format
51-
The IP list file should contain one IP address per line:
52-
The list is automatically scraped from Insecam currently.
53-
```
54-
192.168.1.1
55-
10.0.0.1/video
56-
camera.example.com:8080
57-
```
58-
59-
## Project Structure
27+
Download the latest release for your operating system from the releases tab. If your platform isnt there (e.g. MacOS Intel) make an issue to let me know there is actually demand for it.
6028

61-
```
62-
oversee-main/
63-
├── cam_movement_reversing.md # Trying to add functionality to the move feature
64-
├── prepforcommit.sh # OLD DO NOT USE IT
65-
├── .gitignore # ... Obv its git ignore?
66-
├── website/ # All things that are in the website or the showdan project
67-
│ ├── gui/ # All GUI related code
68-
│ ├── gui/ # All GUI related code
69-
│ ├── gui/ # All GUI related code
70-
├── src/
71-
│ │ ├── maingui.py # Main GUI implementation
72-
│ ├── gui/ # All GUI related code
73-
│ │ ├── maingui.py # Main GUI implementation
74-
│ │ ├── aboutgui.py # Fancy about menu
75-
│ │ ├── focusedstreamgui.py # Open stream in new window
76-
│ │ ├── settingsgui.py # Settigs window
77-
│ │ ├── initgui.py # Loading menu
78-
│ │ ├── movementgui.py # Camera movement remote
79-
│ │ ├── focusedmapgui.py # Focused map view "view on map" in list view
80-
│ │ └── rendermatrix.py # Matrix view rendering
81-
│ ├── backend/ # Not really backend, just camera management stuff
82-
│ │ ├── cameradown.py # All things that are camera > user
83-
│ │ ├── cameraup.py # All things that are user > camera
84-
│ ├── initdata/ # All of the prelaunch prep ran by initgui
85-
│ │ ├── getiplistcoordinates.py # IP coordinate processing
86-
│ │ ├── formatscrapeddata.py # Make the scraped ip list compliant with the program
87-
│ │ ├── getiplist.py # Threaded insecam scraper
88-
│ │ ├── headinit.py # Deprecated and unused function for init (now in initgui)
89-
│ │ ├── validateiplist.py # Remove IPs that don't respond (intentionally broken)
90-
│ │ └── ip2locdownload.py # Download less precise backup IP2Loc databases
91-
│ └── utility/ # Misc escentially.
92-
│ ├── ip2loc.py # IP geolocation utilities
93-
│ ├── camera_manager.py # I think unused (maybe) function for managing timed out streams
94-
│ └── iplist.py # IP list handling (e.g. read range)
95-
├── data/ # Data that the program gets when it runs
96-
│ ├── ip_info.db # IP coordinate database (stump to grow is at [here](https://silverflag.net/oversee/ip_info.raw))
97-
│ ├── other # General backup ip2loc database files
98-
│ └── cameras.db # Camera status database (Online, Offline, Unkown)
99-
├── main.py # Application entry point (runs init and everything)
100-
└── requirements.txt # Python dependencies
101-
```
102-
## Development
29+
## Contributing
30+
Contributions are welcome! Please feel free to submit a Pull Request.
10331

10432
### Adding New Features
10533
1. Fork the repository
@@ -113,19 +41,12 @@ oversee-main/
11341
- Add comments for complex logic
11442
- Update documentation as needed
11543

116-
## Contributing
117-
Contributions are welcome! Please feel free to submit a Pull Request.
118-
119-
## License
120-
None. Steal it and put sprinkles on it.
121-
12244
## Acknowledgments
12345
- IP geolocation data provided by ipinfo.io
12446
- Map tiles from OpenStreetMap and Google Maps
12547
- All contributors and users of the project
12648

12749
## Support
128-
For support, please:
129-
1. Check the documentation (there isn't any yet but there will be)
130-
2. Search existing issues (In GitHub)
131-
3. Create a new issue if needed (Also In GitHub)
50+
All support should be through the issue tracker in the GitHub repository. Please be patient for fixes.
51+
52+
Made with ❤️ by SilverFlag Team & more.

0 commit comments

Comments
 (0)