source: docs/DIRECTORIES.md @ fc8b55df

Last change on this file since fc8b55df was c734b84, checked in by zzz <zzz@…>, 2 years ago

doc update

  • Property mode set to 100644
File size: 4.1 KB
Line 
1# Short directory explaination
2
3This list should give any new developer a kickstart in where to find code that they wish to modify.
4
5Also nice for old developers with weak memory :)
6
7Directory | Description
8 -------  |  ---------
9`apps` | This directory contains applications and clients that ships with i2p.
10`apps/addressbook` | Some headless code for addressbook management.
11`apps/apparmor` | Ruleset for AppArmor.
12`apps/BOB` | Code for the BOB service.
13`apps/desktopgui` | The new system tray application
14`apps/i2psnark` | Code for i2psnark, the torrent client component in webconsole.
15`apps/i2ptunnel` | Code for the Hidden Service Manager, and its GUI in webconsole.
16`apps/imagegen` | The image generator webapp
17`apps/jetty` | Jetty webserver code.
18`apps/jrobin` | Graph package for the console
19`apps/ministreaming` | The streaming (TCP-like socket) interface.
20`apps/routerconsole` | The router console code.
21`apps/routerconsole/java/src/net/i2p/router/news` | The news feed subsystem
22`apps/routerconsole/java/src/net/i2p/router/update` | The automatic update subsystem
23`apps/routerconsole/java/src/net/i2p/router/web` | Java code for the console, including plugin support
24`apps/routerconsole/jsp` | Jsps for the console
25`apps/sam` | SAM service.
26`apps/streaming` | The streaming (TCP-like socket) implementation.
27`apps/susidns` | Code for the addressbook component in the webconsole.
28`apps/susimail` | Code for the mail client component in the webconsole.
29`apps/systray` | The old system tray application, now removed, and some related utilities
30`installer` | This directory contains the code for the installer.
31`installer/lib/izpack` | Installer libraries
32`installer/lib/jbigi` | jbigi and jcpuid DLLs
33`installer/lib/launch4j` | Windows jar-to-exe binary
34`installer/lib/wrapper` | Wrapper binaries and libraries
35`installer/resources` | Used for static files that are packed with i2p.
36`core/java` | Common core code used both by the rotuer and apps.
37`core/java/src/net/i2p/app` | Code for app interface.
38`core/java/src/net/i2p/client` | Low-level client I2CP interface (I2PClient, I2PSession etc.).
39`core/java/src/net/i2p/client/impl` | Client-side I2CP implementation
40`core/java/src/net/i2p/client/naming` | Addressbook interfaces and base implementation
41`core/java/src/net/i2p/crypto` | This directory contain most of the crypto code.
42`core/java/src/net/i2p/data` | Common data structures and data-related utilities
43`core/java/src/net/i2p/internal` | Internal socketless I2CP connections
44`core/java/src/net/i2p/kademlia` | Base Kademlia implementation used by the router and i2psnark
45`core/java/src/net/i2p/socks` | SOCKS client implementation.
46`core/java/src/net/i2p/stat` | Statistics subsystem.
47`core/java/src/net/i2p/time` | Internal time representation
48`core/java/src/net/i2p/update` | Parts of the update code.
49`core/java/src/net/i2p/util` | Utillity code like Log, FileUtil, EepGet, HexDump, and so on.
50`router/java` | This directory contains the I2P router code.
51`router/java/src/net/i2p/data/i2np` | I2NP code, the inner protocol for I2P.
52`router/java/src/net/i2p/data/router` | Router data structures such as RouterInfo
53`router/java/src/net/i2p/router/client` | Router-side I2CP implementation
54`router/java/src/net/i2p/router/crypto` | Router crypto not needed in the core library
55`router/java/src/net/i2p/router/dummy` | Dummy implementation of some subsystems for testing
56`router/java/src/net/i2p/router/message` | Garlic message creation and parsing
57`router/java/src/net/i2p/router/networkdb/kademlia` | The DHT (kademlia) code.
58`router/java/src/net/i2p/router/networkdb/reseed` | The reseed code.
59`router/java/src/net/i2p/router/peermanager` | Peer profile tracking and storage
60`router/java/src/net/i2p/router/startup` | Code related to the startup sequence.
61`router/java/src/net/i2p/router/transport` | Transport implementation code (NTCP, SSU).
62`router/java/src/net/i2p/router/transport/crypto` | Transport crypto (DH)
63`router/java/src/net/i2p/router/tasks` | Small router helpers, run periodically
64`router/java/src/net/i2p/router/tunnel` | Tunnel implementation code.
65`router/java/src/net/i2p/router/util` | Router utilities
66
67 
Note: See TracBrowser for help on using the repository browser.